mirror of
https://codeberg.org/Reuh/feather.git
synced 2025-10-27 18:19:32 +00:00
refactor: everything into several files and a valid python package
This commit is contained in:
parent
58e8a14b93
commit
b0e0c5d0df
15 changed files with 646 additions and 1227 deletions
19
README.md
19
README.md
|
|
@ -40,11 +40,13 @@ After changing the configuration, you can call `feather regenerate` to regenerat
|
|||
|
||||
### Docker
|
||||
|
||||
`podman run -d -v ./config.toml:/feather/config.toml -v feather-data:/feather/data -v ./reader:/feather/reader --name feather feather daemon`
|
||||
`docker run -d -v ./config.toml:/feather/config.toml -v feather-data:/feather/data -v ./reader:/feather/reader --name feather feather daemon`
|
||||
|
||||
### Raw
|
||||
|
||||
You need Python 3.12 or newer. Then pip it up.
|
||||
You need Python 3.12 or newer. Then pip it up, as the kids say.
|
||||
|
||||
`uv run feather`
|
||||
|
||||
## FAQ
|
||||
|
||||
|
|
@ -57,18 +59,9 @@ You need Python 3.12 or newer. Then pip it up.
|
|||
## TODO
|
||||
|
||||
- [ ] Write documentation
|
||||
- [x] Perform mark-as-read operation more often than sync (inotify, daemon, etc.)
|
||||
- [ ] inotify might still be nice for instant reactions
|
||||
- [x] Make HTML filename configurable
|
||||
- [x] Make HTML template configurable
|
||||
- [ ] Nested categories: ttrss-python?
|
||||
- [ ] Use inotify for real-time article mark-as-read action
|
||||
- [ ] Share the fun somewhere
|
||||
- [x] Edge cases: mark as read during sync (if marked as read on server or not)
|
||||
- [x] Proper filename escaping
|
||||
- [x] Command to force regenerate all HTML files (incl. recompute datetimes & paths)
|
||||
- [x] Handle item updates
|
||||
- [ ] Actually think about the issues created by the duplicate warning
|
||||
- [x] Set generated files creation/modification date instead of putting date in filename
|
||||
- [ ] Make a proper Python package
|
||||
- [ ] Attachments
|
||||
- [ ] Test with FreshRSS
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue