Jmaa/favro-sync
1
0
Fork 0
Code Actions

🤖 Repository layout updated to latest version

Browse Source 
This commit was automatically generated by a script: https://gitfub.space/Jmaa/repo-manager
This commit is contained in:
Takunomi Automaticus, The 2nd 2024-09-27 00:01:32 +02:00
parent 244c3fd681
commit 953daff642
2 changed files with 37 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -17,16 +17,39 @@ Uses [`python-fuse`](https://github.com/libfuse/python-fuse) library.
Limitations: Limitations:
- Only works for TODO files. - Only cards in todolist is fetched at the moment.
- Doesn't include title anywhere. - Doesn't include title anywhere.
- Tasks cannot be updated or changed. - Tasks cannot be updated or changed.
- Slow, due to inefficient use of caches.
A more complete implementation will probably require a Markdown parser, to A more complete implementation will probably require a Markdown parser, to
parse the saved input, and distribute it across the various Card fields (card parse the saved input, and distribute it across the various Card fields (card
name, description, tasks, etc...) 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 <MOUNT_DIR>`. 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 MIT License

15
setup.py
View File

@ -24,13 +24,23 @@ Uses [`python-fuse`](https://github.com/libfuse/python-fuse) library.
Limitations: Limitations:
- Only works for TODO files. - Only cards in todolist is fetched at the moment.
- Doesn't include title anywhere. - Doesn't include title anywhere.
- Tasks cannot be updated or changed. - Tasks cannot be updated or changed.
- Slow, due to inefficient use of caches.
A more complete implementation will probably require a Markdown parser, to A more complete implementation will probably require a Markdown parser, to
parse the saved input, and distribute it across the various Card fields (card parse the saved input, and distribute it across the various Card fields (card
name, description, tasks, etc...) 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 <MOUNT_DIR>`. 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() """.strip()
PACKAGE_DESCRIPTION_SHORT = """ PACKAGE_DESCRIPTION_SHORT = """
@ -53,8 +63,7 @@ REQUIREMENTS_MAIN = [
'requests', 'requests',
'secret_loader @ git+https://gitfub.space/Jmaa/secret_loader', 'secret_loader @ git+https://gitfub.space/Jmaa/secret_loader',
] ]
REQUIREMENTS_TEST = [ REQUIREMENTS_TEST = []
]
setup( setup(