Skip to content

lemon24/reader

Repository files navigation

reader is a minimal feed reader.

Build Status Code Coverage Documentation Status PyPI Status

Features:

  • Stable and clearly documented API.
  • Excellent test coverage.
  • Minimal web interface.

Documentation: reader.readthedocs.io

Usage:

$ pip install reader
>>> from reader import Reader
>>>
>>> reader = 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(which='unread')]
['H.I. #107: One Year of Weird', 'H.I. #106: Water on Mars', ...]
>>> [e.title for e in reader.get_entries(which='read')]
['H.I. #108: Project Cyclops']