1
0
Fork 0
mirror of https://codeberg.org/Reuh/feather.git synced 2025-10-27 18:19:32 +00:00
File-based RSS reader client for TT-RSS/FreshRSS/Miniflux/...
Find a file
2025-10-09 18:06:35 +02:00
.gitignore Initial commit 2025-10-09 13:50:18 +02:00
.python-version Initial commit 2025-10-09 13:50:18 +02:00
config.default.toml docs: add environment variables names to defautl config 2025-10-09 16:59:22 +02:00
Dockerfile docs: update 2025-10-09 17:50:09 +02:00
google_reader.py docs: add license to google-reader 2025-10-09 13:55:50 +02:00
LICENSE docs: add LICENSE 2025-10-09 16:55:35 +02:00
main.py feat: add sync-up and sync-down 2025-10-09 18:06:35 +02:00
pyproject.toml feat: use jinja templates for HTML & filenames 2025-10-09 15:30:19 +02:00
README.md feat: add sync-up and sync-down 2025-10-09 18:06:35 +02:00
uv.lock feat: use jinja templates for HTML & filenames 2025-10-09 15:30:19 +02:00

Feather: local file-based RSS reader

Usage

Reading a feed

Marking items as read

Updating with the server

Call feather update to synchronize all local data with the server (read items, new items from the server, etc.).

Configuration

After changing the configuration, you can call feather regenerate to regenerate all local files with the new configuration (to reflect the changes in the HTML template, filenames, etc.).

Theoretical use-cases

Processing with scripts

Syncthing

Installation

Docker

Raw

FAQ

Why

Name

What should I eat tonight

TODO

  • Write documentation
  • Perform mark-as-read operation more often than sync (inotify, daemon, etc.)
  • Make HTML filename configurable
  • Make HTML template configurable
  • Nested categories
  • Share the fun somewhere
  • Edge cases: mark as read during sync (if marked as read on server or not)
  • Proper filename escaping
  • Command to force regenerate all HTML files (incl. recompute datetimes & paths)
  • Handle item updates
  • Actually think about the issues created by the duplicate warning