Skip to main content

A Python feed reader library.

Project description

reader is a Python feed reader library.

It is designed to allow writing feed reader applications without any business code, and without depending on a particular framework.

build status (GitHub Actions) code coverage documentation status PyPI status checked with mypy code style: black

reader allows you to:

  • retrieve, store, and manage Atom, RSS, and JSON feeds

  • mark articles as read or important

  • add arbitrary tags/metadata to feeds and articles

  • filter feeds and articles

  • full-text search articles

  • get statistics on feed and user activity

  • write plugins to extend its functionality

  • skip all the low level stuff and focus on what makes your feed reader different

…all these with:

  • a stable, clearly documented API

  • excellent test coverage

  • fully typed Python

What reader doesn’t do:

  • provide an UI

  • provide a REST API (yet)

  • depend on a web framework

  • have an opinion of how/where you use it

The following exist, but are optional (and frankly, a bit unpolished):

  • a minimal web interface

    • that works even with text-only browsers

    • with automatic tag fixing for podcasts (MP3 enclosures)

  • a command-line interface

Documentation: reader.readthedocs.io

Usage:

$ pip install reader
>>> from reader import make_reader
>>>
>>> reader = make_reader('db.sqlite')
>>> reader.add_feed('http://www.hellointernet.fm/podcast?format=rss')
>>> reader.update_feeds()
>>>
>>> entries = list(reader.get_entries())
>>> [e.title for e in entries]
['H.I. #108: Project Cyclops', 'H.I. #107: One Year of Weird', ...]
>>>
>>> reader.mark_entry_as_read(entries[0])
>>>
>>> [e.title for e in reader.get_entries(read=False)]
['H.I. #107: One Year of Weird', 'H.I. #106: Water on Mars', ...]
>>> [e.title for e in reader.get_entries(read=True)]
['H.I. #108: Project Cyclops']
>>>
>>> reader.update_search()
>>>
>>> for e in reader.search_entries('year', limit=3):
...     title = e.metadata.get('.title')
...     print(title.value, title.highlights)
...
H.I. #107: One Year of Weird (slice(15, 19, None),)
H.I. #52: 20,000 Years of Torment (slice(17, 22, None),)
H.I. #83: The Best Kind of Prison ()

Project details


Release history Release notifications | RSS feed

This version

3.18

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reader-3.18.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

reader-3.18-py3-none-any.whl (259.7 kB view details)

Uploaded Python 3

File details

Details for the file reader-3.18.tar.gz.

File metadata

  • Download URL: reader-3.18.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for reader-3.18.tar.gz
Algorithm Hash digest
SHA256 b6df6fa86aec1cfff7520107ce69e3356f1431d626e9fc91dcb486c5cca191d8
MD5 d970e62a57ba8a6cb27c862a98c42ac9
BLAKE2b-256 94a535ba878f75362b46edfd9e820d2b407b52b600b4bfe64257f6cd5a9a1026

See more details on using hashes here.

File details

Details for the file reader-3.18-py3-none-any.whl.

File metadata

  • Download URL: reader-3.18-py3-none-any.whl
  • Upload date:
  • Size: 259.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for reader-3.18-py3-none-any.whl
Algorithm Hash digest
SHA256 757604cc4321f23e15f2529159874feb04dca6caa29ba0c932010304d91c1ae3
MD5 df040fce93dfd0170d8be7c0dbae2862
BLAKE2b-256 74a7db6aa5e071c3081713457148d74ef919767500cf2d6a4b382debd4cc634d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page