diff --git a/README.md b/README.md index 08075db..c88628d 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,21 @@ Filesystem in User Space for Favro. Synchronize your local notes and your Favro. +Uses the [Favro API](https://favro.com/developer/). Rate limiting depends upon +your organization's payment plan. + +Uses [`python-fuse`](https://github.com/libfuse/python-fuse) library. + +Limitations: + +- Only works for TODO files. +- Doesn't include title anywhere. +- Tasks cannot be updated or changed. + +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...) + # License diff --git a/favro_sync/__init__.py b/favro_sync/__init__.py index 66ca511..0c45c69 100644 --- a/favro_sync/__init__.py +++ b/favro_sync/__init__.py @@ -8,4 +8,14 @@ Uses the [Favro API](https://favro.com/developer/). Rate limiting depends upon your organization's payment plan. Uses [`python-fuse`](https://github.com/libfuse/python-fuse) library. + +Limitations: + +- Only works for TODO files. +- Doesn't include title anywhere. +- Tasks cannot be updated or changed. + +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...) """ diff --git a/setup.py b/setup.py index e0c504f..0e59457 100644 --- a/setup.py +++ b/setup.py @@ -16,6 +16,21 @@ PACKAGE_DESCRIPTION = """ Filesystem in User Space for Favro. Synchronize your local notes and your Favro. + +Uses the [Favro API](https://favro.com/developer/). Rate limiting depends upon +your organization's payment plan. + +Uses [`python-fuse`](https://github.com/libfuse/python-fuse) library. + +Limitations: + +- Only works for TODO files. +- Doesn't include title anywhere. +- Tasks cannot be updated or changed. + +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...) """.strip() PACKAGE_DESCRIPTION_SHORT = """ @@ -38,7 +53,8 @@ REQUIREMENTS_MAIN = [ 'requests', 'secret_loader @ git+https://gitfub.space/Jmaa/secret_loader', ] -REQUIREMENTS_TEST = [] +REQUIREMENTS_TEST = [ +] setup(