favro-sync (0.1.7)
Published 2024-11-16 18:00:19 +00:00 by Jmaa
Installation
pip install --index-url favro-sync
About this package
Filesystem in User Space for Favro.
Favro Sync.
Filesystem in User Space for Favro.
Synchronize your local notes and your Favro.
Uses the Favro API. Rate limiting depends upon your organization's payment plan.
Uses python-fuse
library.
Features:
- Local access to cards in todolist.
- Read card features:
- Title
- Description
- Tags
- Assignees
- Dependencies
- Custom fields
- Change card features:
- Title
- Description
- Obsidian 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.
- 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
- Install dependencies
pip install -r requirements.txt
- Setup secrets:
FAVRO_ORGANIZATION_ID
,FAVRO_USERNAME
,FAVRO_PASSWORD
. - Run
python -m favro_sync <MOUNT_DIR>
. Use the--help
argument to get an overview of all supported flags (there is a lot, becausepython-fuse
implements a whole bunch automatically.)
Architecture
FavroFuse
- Markdown Parser/Renderer
FavroClient
CardCache
Work in Progress
Following features are work in progress:
- Frontmatter: Writable Tags
- Frontmatter: Writable assigned members
- Frontmatter: Writable Tasks.
- Save updated TaskList along with card (using
PUT cards
) - Get the Card's TaskList.
- Remove all TaskList's except for the latest (how to determine latest?)
- That's three requests just to save a freaking list of tasks!
- Save updated TaskList along with card (using
- Frontmatter: Writable Dependencies.
- Usability: Richer directory structure
- Usability: Allow users to toggle Obsidian mode, instead of being default.
- Precision: Get the correct last-modified date.
- Performance: Improve cache behaviour. User and tags can have much longer cache times.
- Performance: Parallelize requests.
- Paginated pages can be easily parallelize.
- Frontmatter: Arbitrary structured data (Custom Fields)? Read-only.
- Frontmatter: Readable Dependencies. As vault links in Obsidian mode.
Requirements
Requires Python: >=3.9
Details
Assets (2)
Versions (3)
View all
favro_sync-0.1.7.tar.gz
14 KiB