reader
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.
Features
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
Quickstart
What does it look like? Here is an example of reader in use:
$ 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 ()
User guide
This part of the documentation guides you through all of the library’s usage patterns.
- Why reader?
- Installation
- Tutorial
- User guide
- The Reader object
- Adding feeds
- File-system access
- Deleting feeds
- Updating feeds
- Getting feeds
- Changing feed URLs
- Getting entries
- Entry flags
- Full-text search
- Resource tags
- Counting things
- Deleting entries
- Pagination
- Plugins
- Feed and entry arguments
- Streaming methods
- Reserved names
- Advanced feedparser features
- Errors and exceptions
API reference
If you are looking for information on a specific function, class, or method, this part of the documentation is for you.
Unstable features
The following are optional features that are still being worked on. They may become their own packages, get merged into the main library, or be removed in the future.
Project information
reader is released under the BSD license, its documentation lives at Read the Docs, the code on GitHub, and the latest release on PyPI. It is rigorously tested on Python 3.10+ and PyPy.
- How to contribute to reader
- Development
- Changelog
- Version 3.16
- Version 3.15
- Version 3.14
- Version 3.13
- Version 3.12
- Version 3.11
- Version 3.10
- Version 3.9
- Version 3.8
- Version 3.7
- Version 3.6
- Version 3.5
- Version 3.4
- Version 3.3
- Version 3.2
- Version 3.1
- Version 3.0
- Version 2.17
- Version 2.16
- Version 2.15
- Version 2.14
- Version 2.13
- Version 2.12
- Version 2.11
- Version 2.10
- Version 2.9
- Version 2.8
- Version 2.7
- Version 2.6
- Version 2.5
- Version 2.4
- Version 2.3
- Version 2.2
- Version 2.1
- Version 2.0
- Version 1.20
- Version 1.19
- Version 1.18
- Version 1.17
- Version 1.16
- Version 1.15
- Version 1.14
- Version 1.13
- Version 1.12
- Version 1.11
- Version 1.10
- Version 1.9
- Version 1.8
- Version 1.7
- Version 1.6
- Version 1.5
- Version 1.4
- Version 1.3
- Version 1.2
- Version 1.1
- Version 1.0.1
- Version 1.0
- Version 0.22
- Version 0.21
- Version 0.20
- Version 0.19
- Version 0.18
- Version 0.17
- Version 0.16
- Version 0.15
- Version 0.14
- Version 0.13
- Version 0.12
- Version 0.11
- Version 0.10
- Version 0.9
- Version 0.8
- Version 0.7
- Version 0.6
- Version 0.5
- Version 0.4
- Version 0.3
- Version 0.2
- Version 0.1.1
- Version 0.1