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; in MVC terms, you’d probably call it a fat model.

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

  • import / export feeds as OPML

  • automatically discover feeds in web pages

  • 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:

  • depend on a web framework

  • have an opinion of how or where you use it

In addition, reader provides:

  • an optional web application based on Flask, Bootstrap, and htmx

  • an optional 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 links

Data verified by PyPI on Jun 24, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for lemon24 from gravatar.com lemon24

Credits

Author: lemon24

GitHub Statistics

Data verified by PyPI on Jun 24, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

BSD License (BSD-3-Clause)

Requires

Python >=3.11

Provides Extra

all cli app unstable-plugins

Tags

atom cdf feed rdf rss json feed web feed podcast feed reader feed aggregator

Classifiers

Report project as malware

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.26.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reader-3.26-py3-none-any.whl (693.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: reader-3.26.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for reader-3.26.tar.gz
Algorithm Hash digest
SHA256 2b6ad65066f46c35609e047681771632856cb9f82b705e1c9614d83a066f28d9
MD5 778b12e4c2c8817808e529297433256b
BLAKE2b-256 2b0784a8900ca9d324efa57fc23f82f1b36685526b895e7010d5782bb3e5e0a7

See more details on using hashes here.

Provenance

The following attestation bundles were made for reader-3.26.tar.gz:

Publisher: publish.yaml on lemon24/reader

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: reader-3.26-py3-none-any.whl
  • Upload date:
  • Size: 693.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for reader-3.26-py3-none-any.whl
Algorithm Hash digest
SHA256 ffefb748152e6d88a38b80452fbe12c40c7fdaa5d2d181464a641612744e6d38
MD5 399843dc896e672974e69980a4b44092
BLAKE2b-256 cf22c8fcf5b534c4d6e1eeab41c93493e7685a89c7ec6f7ed2f0c1993d2567ab

See more details on using hashes here.

Provenance

The following attestation bundles were made for reader-3.26-py3-none-any.whl:

Publisher: publish.yaml on lemon24/reader

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

3.26

3.25

3.24

3.23

3.22

3.21

3.20

3.19

3.18

3.17

3.16

3.15

3.14

3.13

3.12

3.11

3.10

3.9

3.8

3.7

3.6

3.5

3.4

3.3

3.2

3.1

3.0

3.0rc1 pre-release

2.17

2.16

2.15

2.14

2.13

2.12

2.11

2.10

2.9

2.8

2.7

2.6

2.5

2.4

2.3

2.2 yanked

Reason this release was yanked:

https://reader.readthedocs.io/en/latest/changelog.html#yanked-2-2

2.1

2.0

1.20

1.19

1.18

1.17

1.16

1.15

1.14

1.13

1.12

1.11

1.10

1.9

1.8

1.7

1.6

1.5

1.4

1.3

1.2

1.1

1.0.1

1.0 yanked

0.22 yanked

0.21 yanked

0.20 yanked

0.19

0.18

0.17

0.16

0.15

0.14

0.13

0.12

0.11

0.10

0.9

0.8

0.7

0.6

0.5

0.4

0.3

0.2

0.1.1

0.1.post0

Supported by

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