reader 1.0.1

A minimal feed reader library.

reader is a Python feed reader library.

reader can be used to retrieve, store, and manage Atom and RSS feeds. It is designed to allow writing feed reader applications without any business code, and without enforcing a dependency on a particular framework.

Features:

• Stand-alone library with stable, clearly documented API, and excellent test coverage.

• Full-text search.

• Minimal web interface that works even with text-only browsers.

  • … with automatic tag fixing for podcasts (MP3 enclosures).

• (Some) plugin support.

Documentation: reader.readthedocs.io

Usage:

$ pip install reader[search]

>>> 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_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.enable_search()
>>> reader.update_search()
>>>
>>> for e in list(reader.search_entries('year'))[: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 ()