From 412a20b006a6b7d85cdf99acbb8aa9dced778018 Mon Sep 17 00:00:00 2001 From: Jon Michael Aanes Date: Mon, 30 Sep 2024 12:50:43 +0200 Subject: [PATCH] Fixed setup.py --- setup.py | 48 +++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 41 insertions(+), 7 deletions(-) diff --git a/setup.py b/setup.py index 1405de9..88df9aa 100644 --- a/setup.py +++ b/setup.py @@ -22,16 +22,29 @@ your organization's payment plan. Uses [`python-fuse`](https://github.com/libfuse/python-fuse) library. +Features: + +- Local access to cards in todolist. +- Read card features: + - Title + - Description + - Tags + - Assignees + - Dependencies +- Change card features: + - Title + - Description +- [Obsidian](https://obsidian.md/) compatibility: + - Mountable within your vault. + - Link to cards by either card number or card title. + - Tags and dependencies are integrated. + Limitations: - 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...) +- Tasks (checklists on cards) cannot be updated or changed. +- Images cannot be updated or changed. +- You cannot create new cards, nor any other files. ## Usage @@ -41,6 +54,25 @@ name, description, tasks, etc...) overview of all supported flags (there is a lot, because [`python-fuse`](https://github.com/libfuse/python-fuse) implements a whole bunch automatically.) + +## Architecture + +- `FavroFuse` +- Markdown Parser/Renderer +- `FavroClient` + - `CardCache` + +## Work in Progress + +Following features are work in progress: + +- [ ] Frontmatter: Update Tags +- [ ] Frontmatter: Updated assigned members +- [ ] Frontmatter: Arbitrary structured data? Read-only. +- [ ] Frontmatter: Dependencies. As vault links in Obsidian mode. +- [ ] Allow users to toggle Obsidian mode, instead of being default. +- [ ] Get the correct last-modified date. +- [ ] Improve cache behaviour. User and tags can have much longer cache times. """.strip() PACKAGE_DESCRIPTION_SHORT = """ @@ -64,6 +96,8 @@ REQUIREMENTS_MAIN = [ 'requests-cache', 'fuse-python', 'secret_loader @ git+https://gitfub.space/Jmaa/secret_loader', + 'marko', + 'python-frontmatter', ] REQUIREMENTS_TEST = [ 'pytest',