diff --git a/README.md b/README.md index c88628d..0358350 100644 --- a/README.md +++ b/README.md @@ -17,16 +17,39 @@ Uses [`python-fuse`](https://github.com/libfuse/python-fuse) library. Limitations: -- Only works for TODO files. +- Only cards in todolist is fetched at the moment. - Doesn't include title anywhere. - Tasks cannot be updated or changed. +- Slow, due to inefficient use of caches. A more complete implementation will probably require a Markdown parser, to parse the saved input, and distribute it across the various Card fields (card name, description, tasks, etc...) +## Usage -# License +1. Install dependencies `pip install -r requirements.txt` +2. Setup [secrets](https://gitfub.space/Jmaa/secret_loader]): `FAVRO_ORGANIZATION_ID`, `FAVRO_USERNAME`, `FAVRO_PASSWORD`. +3. Run `python -m favro_sync `. Use the `--help` argument to get an + overview of all supported flags (there is a lot, because + [`python-fuse`](https://github.com/libfuse/python-fuse) implements a whole + bunch automatically.) + + +## Dependencies + +All requirements can be installed easily using: + +```bash +pip install -r requirements.txt +``` + +Full list of requirements: +- [requests](https://pypi.org/project/requests/) +- [secret_loader](https://gitfub.space/Jmaa/secret_loader) + + +## License ``` MIT License diff --git a/setup.py b/setup.py index 0e59457..432afa6 100644 --- a/setup.py +++ b/setup.py @@ -24,13 +24,23 @@ Uses [`python-fuse`](https://github.com/libfuse/python-fuse) library. Limitations: -- Only works for TODO files. +- Only cards in todolist is fetched at the moment. - Doesn't include title anywhere. - Tasks cannot be updated or changed. +- Slow, due to inefficient use of caches. A more complete implementation will probably require a Markdown parser, to parse the saved input, and distribute it across the various Card fields (card name, description, tasks, etc...) + +## Usage + +1. Install dependencies `pip install -r requirements.txt` +2. Setup [secrets](https://gitfub.space/Jmaa/secret_loader]): `FAVRO_ORGANIZATION_ID`, `FAVRO_USERNAME`, `FAVRO_PASSWORD`. +3. Run `python -m favro_sync `. Use the `--help` argument to get an + overview of all supported flags (there is a lot, because + [`python-fuse`](https://github.com/libfuse/python-fuse) implements a whole + bunch automatically.) """.strip() PACKAGE_DESCRIPTION_SHORT = """ @@ -53,8 +63,7 @@ REQUIREMENTS_MAIN = [ 'requests', 'secret_loader @ git+https://gitfub.space/Jmaa/secret_loader', ] -REQUIREMENTS_TEST = [ -] +REQUIREMENTS_TEST = [] setup(