From 56dc16c93e53db425f30f62550cd7770f180d5d4 Mon Sep 17 00:00:00 2001 From: takunomi-build-bot Date: Thu, 23 Jan 2025 13:46:01 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20Repository=20layout=20updated=20?= =?UTF-8?q?to=20latest=20version?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This commit was automatically generated by a script: https://gitfub.space/Jmaa/repo-manager --- LICENSE | 2 +- README.md | 43 +++++++++++++++++++++++++++++++++++++++---- setup.py | 41 ++++++++++++++++++++++++++++++++++++++--- 3 files changed, 78 insertions(+), 8 deletions(-) diff --git a/LICENSE b/LICENSE index 67061b0..991257a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2024 Jon Michael Aanes +Copyright (c) 2024-2025 Jon Michael Aanes Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index d0274ca..e8007ab 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,14 @@ your organization's payment plan. Uses [`python-fuse`](https://github.com/libfuse/python-fuse) library. +## Features + +The feature set is mainly aimed towards giving a better writing experience in +Favro. Management and organization features have been left out. + Features: -- Local access to cards in todolist. +- Access collections and cards in a file hierarchy. - Read card features: - Title - Description @@ -37,10 +42,10 @@ Features: 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. +- Collection order is not presented. ## Usage @@ -51,6 +56,36 @@ Limitations: [`python-fuse`](https://github.com/libfuse/python-fuse) implements a whole bunch automatically.) +Use `umount` to unmount the mounted directory again. + +### Directory structure and latency + +Directory structure is something like: + +``` +mount + -> Collection A + -> CARD-101 + -> CARD-111 + -> ... + -> Collection B + -> CARD-201 + -> CARD-221 + -> ... + -> ... +``` + +Some programs like Obsidian eagerly load and cache unneeded files in memory, +which can reduce performance when those files are fetched over a network. You +can limit this by configuring favro-sync to only expose individual collections +by adding a `FAVRO_COLLECTION_FILTER` secret containing allowed collection +names, like so: + +``` +Collection A +Collection B +``` + ## Architecture - `FavroFuse` @@ -70,12 +105,12 @@ Following features are work in progress: 3. Remove all TaskList's except for the latest (how to determine latest?) 4. That's three requests just to save a freaking list of tasks! - [ ] 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. +- [X] Usability: Richer directory structure - [X] Frontmatter: Arbitrary structured data (Custom Fields)? Read-only. - [X] Frontmatter: Readable Dependencies. As vault links in Obsidian mode. @@ -102,7 +137,7 @@ Full list of requirements: ``` MIT License -Copyright (c) 2024 Jon Michael Aanes +Copyright (c) 2024-2025 Jon Michael Aanes Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/setup.py b/setup.py index 09c53cb..42a072d 100644 --- a/setup.py +++ b/setup.py @@ -22,9 +22,14 @@ your organization's payment plan. Uses [`python-fuse`](https://github.com/libfuse/python-fuse) library. +## Features + +The feature set is mainly aimed towards giving a better writing experience in +Favro. Management and organization features have been left out. + Features: -- Local access to cards in todolist. +- Access collections and cards in a file hierarchy. - Read card features: - Title - Description @@ -42,10 +47,10 @@ Features: 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. +- Collection order is not presented. ## Usage @@ -56,6 +61,36 @@ Limitations: [`python-fuse`](https://github.com/libfuse/python-fuse) implements a whole bunch automatically.) +Use `umount` to unmount the mounted directory again. + +### Directory structure and latency + +Directory structure is something like: + +``` +mount + -> Collection A + -> CARD-101 + -> CARD-111 + -> ... + -> Collection B + -> CARD-201 + -> CARD-221 + -> ... + -> ... +``` + +Some programs like Obsidian eagerly load and cache unneeded files in memory, +which can reduce performance when those files are fetched over a network. You +can limit this by configuring favro-sync to only expose individual collections +by adding a `FAVRO_COLLECTION_FILTER` secret containing allowed collection +names, like so: + +``` +Collection A +Collection B +``` + ## Architecture - `FavroFuse` @@ -75,12 +110,12 @@ Following features are work in progress: 3. Remove all TaskList's except for the latest (how to determine latest?) 4. That's three requests just to save a freaking list of tasks! - [ ] 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. +- [X] Usability: Richer directory structure - [X] Frontmatter: Arbitrary structured data (Custom Fields)? Read-only. - [X] Frontmatter: Readable Dependencies. As vault links in Obsidian mode. """.strip()