diff --git a/README.md b/README.md index d93052c..f2b73a1 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ start with pictures/gif each time ### Navigating feeds -Directories, sorting/searching by date/title (a.k.a. using a file manager) +Directories, sorting/searching by date/title (a.k.a. using a file manager), flattening nested dirs, etc. ### Reading an article @@ -37,12 +37,12 @@ After changing the configuration, you can call `feather regenerate` to regenerat `feather clear-data` -### Theoretical use-cases - -#### Processing with scripts +### Layer other things on top #### Syncthing +#### Processing with scripts + ## Installation ### Docker @@ -65,9 +65,14 @@ You need Python 3.12 or newer. Then pip it up, as the kids say. ## TODO +before publishing: + - [ ] Write documentation -- [ ] Use inotify for real-time article mark-as-read action - [ ] Share the fun somewhere -- [ ] Get article attachments - [ ] Test with FreshRSS +"i'll look into it later": + +- [ ] Get article attachments +- [ ] Use inotify for real-time article mark-as-read action +- [ ] Partial sync (using since_id for ttrss and start_time for googlereader) diff --git a/src/feather/config.default.toml b/src/feather/config.default.toml index 56455f9..bc29897 100644 --- a/src/feather/config.default.toml +++ b/src/feather/config.default.toml @@ -4,7 +4,7 @@ # - setting environment variables for the values you want to overwrite (the environment variable name for each value can be found in the comments below). [server] -# Server API to use. Either "googlereader" for the Google Reader API (FreshRSS, Miniflux, etc.) or "ttrss" for the TinyTiny-RSS API. +# (Required) Server API to use. Either "googlereader" for the Google Reader API (FreshRSS, Miniflux, etc.) or "ttrss" for the TinyTiny-RSS API. # The Google Reader API do not support nested categories. api = "googlereader" # (Required) URL of your server's Google Reader API endpoint @@ -64,9 +64,12 @@ article_template = ''' {{ title }} - - -
+ + +

{{ published }} @@ -74,7 +77,7 @@ article_template = ''' {% endif %} {% if feed_icon_url %} - + {% endif %} {{ feed_title }} {% if feed_url %} @@ -85,10 +88,12 @@ article_template = '''

{{ title }}

{{ author }}

{% if content %} -
{{ content | safe }}
+
{{ content | safe }}
{% else %} - -
{{ summary | safe }}
+
+ + {{ summary | safe }} +
{% endif %}
diff --git a/src/feather/config.py b/src/feather/config.py index e7c9314..fdda69d 100644 --- a/src/feather/config.py +++ b/src/feather/config.py @@ -47,7 +47,7 @@ class Config: self.html_root: Path = Path(get_config("directories", "reader")) self.json_root: Path = Path(get_config("directories", "data")) - self.server_api: str = str(get_config("server", "api")) + self.server_api: str = str(get_config("server", "api", False)) if self.server_api not in ("googlereader", "ttrss"): raise ConfigurationError( f"server.api must be either ttrss or googlereader, not {self.server_api}"