From aeea92b65cb3aa6ba09b447e6b2ee0683b586766 Mon Sep 17 00:00:00 2001 From: Astariul Date: Wed, 27 Mar 2024 09:50:43 +0900 Subject: [PATCH 1/7] Fix README dead links --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2f91362..06618cb 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,7 @@ if __name__ == "__main__": ``` > [!TIP] -> Make sure to check the [full documentation](https://FleksySDK.github.io/kebbie/usage/) for a detailed explanations of how to use the code ! +> Make sure to check the [full documentation](https://FleksySDK.github.io/kebbie/latest/usage/) for a detailed explanations of how to use the code ! --- @@ -100,7 +100,7 @@ kebbie evaluate -K ios --all_tasks ``` > [!TIP] -> Make sure to check the [full documentation](https://FleksySDK.github.io/kebbie/emulated_keyboard/) for a detailed explanations of how to setup emulators and how to use the command line ! +> Make sure to check the [full documentation](https://FleksySDK.github.io/kebbie/latest/emulated_keyboard/) for a detailed explanations of how to setup emulators and how to use the command line !

Contribute

From fb1f5cdc09d339bfb7f8e31babe91a24deefe86d Mon Sep 17 00:00:00 2001 From: Astariul Date: Wed, 27 Mar 2024 09:51:52 +0900 Subject: [PATCH 2/7] =?UTF-8?q?=F0=9F=93=9D=20Fix=20typos=20in=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- docs/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 06618cb..dbe2746 100644 --- a/README.md +++ b/README.md @@ -141,7 +141,7 @@ pytest --- -Tests are not included in the pre-commit hooks, because running the tests might be slow, and for the sake of developpers we want the pre-commit hooks to be fast ! +Tests are not included in the pre-commit hooks, because running the tests might be slow, and for the sake of developers we want the pre-commit hooks to be fast ! Pre-commit hooks will not run the tests, but it will automatically update the coverage badge ! diff --git a/docs/index.md b/docs/index.md index 7f44a42..6486f8d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -112,7 +112,7 @@ pytest ``` !!! info - Tests are not included in the pre-commit hooks, because running the tests might be slow, and for the sake of developpers we want the pre-commit hooks to be fast ! + Tests are not included in the pre-commit hooks, because running the tests might be slow, and for the sake of developers we want the pre-commit hooks to be fast ! !!! info Pre-commit hooks will not run the tests, but it will automatically update the coverage badge ! From 1b321493f53a5cb7ee6a474de06f791c29dfe274 Mon Sep 17 00:00:00 2001 From: Astariul Date: Wed, 27 Mar 2024 10:02:45 +0900 Subject: [PATCH 3/7] =?UTF-8?q?=F0=9F=93=9D=20Improve=20documentation=20by?= =?UTF-8?q?=20mentioning=20what=20to=20install=20(optional=20dependencies)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 13 +++++++++++++ docs/index.md | 13 +++++++++++++ 2 files changed, 26 insertions(+) diff --git a/README.md b/README.md index dbe2746..6c8cf68 100644 --- a/README.md +++ b/README.md @@ -114,6 +114,7 @@ Pre-commit hooks are set to check the code added whenever you commit something. If you never ran the hooks before, install it with : ```bash +pip install -e .[hook] pre-commit install ``` @@ -133,6 +134,12 @@ pre-commit run --all-files When you contribute, you need to make sure all the unit-tests pass. You should also add tests if necessary ! +> [!NOTE] +> Install the dependencies for testing with : +> ```bash +> pip install -e .[test] +> ``` + You can run the tests with : ```bash @@ -152,3 +159,9 @@ The documentation should be kept up-to-date. You can visualize the documentation ```bash mkdocs serve ``` + +> [!NOTE] +> Before running this command, you need to install the documentation dependencies : +> ```bash +> pip install -e .[docs] +> ``` diff --git a/docs/index.md b/docs/index.md index 6486f8d..8b7ae79 100644 --- a/docs/index.md +++ b/docs/index.md @@ -92,6 +92,7 @@ When you try to commit your code, hooks are automatically run, and if you code d !!! important If you never ran the hooks before, install it with : ```bash + pip install -e .[hook] pre-commit install ``` @@ -105,6 +106,12 @@ When you try to commit your code, hooks are automatically run, and if you code d When you contribute, you need to make sure all the unit-tests pass. You should also add tests if necessary ! +!!! info + Install the dependencies for testing with : + ```bash + pip install -e .[test] + ``` + You can run the tests with : ```bash @@ -126,3 +133,9 @@ You can visualize the documentation locally by running : ```bash mkdocs serve ``` + +!!! info + Before running this command, you need to install the documentation dependencies : + ```bash + pip install -e .[docs] + ``` From e035fa4e18b82fd66434409984b1cd48c2ef951f Mon Sep 17 00:00:00 2001 From: Astariul Date: Wed, 27 Mar 2024 10:05:41 +0900 Subject: [PATCH 4/7] =?UTF-8?q?=F0=9F=93=9D=20Better=20README=20with=20adm?= =?UTF-8?q?onitions?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 6c8cf68..42b7b49 100644 --- a/README.md +++ b/README.md @@ -111,24 +111,20 @@ To contribute, install the package locally, create your own branch, add your cod Pre-commit hooks are set to check the code added whenever you commit something. -If you never ran the hooks before, install it with : - -```bash -pip install -e .[hook] -pre-commit install -``` - ---- +> [!NOTE] +> If you never ran the hooks before, install it with : +> ```bash +> pip install -e .[hook] +> pre-commit install +> ``` Then you can just try to commit your code. If your code does not meet the quality required by linters, it will not be committed. You can just fix your code and try to commit again ! ---- - -You can manually run the pre-commit hooks with : - -```bash -pre-commit run --all-files -``` +> [!TIP] +> You can manually run the pre-commit hooks with : +> ```bash +> pre-commit run --all-files +> ``` ### Tests From cea540554c515d4ab5cd6ad6bf6993e2b19e6818 Mon Sep 17 00:00:00 2001 From: Astariul Date: Wed, 27 Mar 2024 10:16:07 +0900 Subject: [PATCH 5/7] =?UTF-8?q?=F0=9F=93=8C=20Add=20missing=20datasets=20d?= =?UTF-8?q?ependency?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- setup.py | 1 + 1 file changed, 1 insertion(+) diff --git a/setup.py b/setup.py index 611c5c7..a245eaa 100644 --- a/setup.py +++ b/setup.py @@ -6,6 +6,7 @@ reqs = [ "regex", + "datasets~=2.18", "scipy~=1.12", "numpy~=1.26", "requests~=2.31", From 3846e7cd2e3229b2fb004b43a673ce58a7420ff3 Mon Sep 17 00:00:00 2001 From: Astariul Date: Wed, 27 Mar 2024 10:37:29 +0900 Subject: [PATCH 6/7] =?UTF-8?q?=F0=9F=99=88=20Update=20gitignore?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 1685955..46032ec 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ __pycache__/ # Setup *.egg-info/ +build/ # Coverage output .coverage From 03e42125079b6fdda736ecd5de96bdd41a6e35b8 Mon Sep 17 00:00:00 2001 From: Astariul Date: Wed, 27 Mar 2024 10:37:56 +0900 Subject: [PATCH 7/7] =?UTF-8?q?=F0=9F=9A=80=20Fix=20setup.py=20to=20includ?= =?UTF-8?q?e=20layout=20file?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- setup.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/setup.py b/setup.py index a245eaa..129eb9d 100644 --- a/setup.py +++ b/setup.py @@ -37,6 +37,8 @@ long_description_content_type="text/markdown", url="https://github.com/FleksySDK/kebbie", packages=setuptools.find_packages(), + package_data={"": ["layouts/*.json"]}, + include_package_data=True, classifiers=[ "Programming Language :: Python :: 3.9", "Operating System :: OS Independent",