Skip to content

Latest commit

 

History

History
94 lines (62 loc) · 3.77 KB

TODO.rst

File metadata and controls

94 lines (62 loc) · 3.77 KB
Raw

Seeking Contributions

Known bugs and desirable features for which contributions are most welcome.

Required

High Priority

  1. Add an enclosure plugin to create playlists.

  2. Any documentation improvements!

    Documentation benefits perhaps most from the attention of fresh eyes. If you find anything confusing, please ask for clarification and once you understand what you didn't before, please do contribute changes to the documentation to spare future users the same confusion.

  3. Initialize Python's mimetypes module with same mime.types file as is used by the static site server:

    $ docker run -it --entrypoint find nginx -name "mime.types"
./etc/nginx/mime.types

  4. Rename to match the Servarr convention: feederr.

  5. Option to use an alternate element as each item's unique identifier within a feed. Also requires generalized element value handling (e.g. value attribute vs an element's child text nodes).

  6. Parallelize both the processing of whole feeds and the downloading of enclosures and assets within each feed using a shared pool. Maybe using:

  7. Determine if HTTP/2 is a significant performance improvement for serving large media files and integrate into the Traefik -> Nginx stack if yes.

Nice to Have

  1. Feed config option to override downloads XPath expression.
  2. Option to re-download enclosures/assets if Last-Modified/If-Modified-Since/If-Unmodified-Since
  3. Option to re-download enclosures/assets if Content-Length is different
  4. A 404 handler or somesuch to add feeds to ./.feed-archiver.yml and run $ feed-archiver automatically? IOW, transform feed URL and add to pod-catcher app and "it just works".
  5. Add prune sub-command to remove all downloads not referenced in any archive feed file.
  6. Order new items based on which siblings they're next to in the previous feed version.
  7. Extension point (setuptools entry points?) for selecting specialized download handlers based on MIME type (e.g. HTML page assets/resources below).
  8. Also download all assets/resources for HTML downloads, possibly with pywebcopy.
  9. Cleanup embedded enclosure metadata (e.g. ID3 tags in MP3) based on item data. For example, add missing ID3 tag with title from the item XML.
  10. Improve XML namespace map/prefix for custom attributes.
  11. Archive config option to specify the list of safe characters for quoting.
  12. Maybe allow Unicode in filesystem path escaping? Do most filesystems support Unicode, for instance? How do static file servers handle Unicode in filesystem paths?
  13. Option to use hard links instead of symlinks.
  14. More examples of template configurations to match feed metadata: e.g. prepending <itunes:episode> to link basename, extracting album directory from feed item title.