Installation

Python versions

reader supports Python 3.11 and newer, and PyPy.

Dependencies

These packages will be installed automatically when installing reader:

feedparser parses Atom and RSSfeeds.
requests retrieves feeds from the internet.
werkzeug provides HTTP utilities.
beautifulsoup4 is used to strip HTML tags and by various plugins.
structlog is used for structured logging.
typing-extensions is used for typing backports.

reader also depends on the sqlite3 standard library module (at least SQLite 3.18 with the JSON1 and FTS5 extensions).

Note

The feedparser main branch contains a change that decreases memory usage by ~35% during feed updates; as of feedparser 6.0.14, this change is not yet included in PyPI releases; to benefit from it, install feedparser directly from GitHub.

Optional dependencies

Despite coming with a CLI and web application, reader is primarily a library. As such, most dependencies are optional, and can be installed as extras.

As of version 3.27, reader has the following extras:

cli installs the dependencies needed for the command-line interface.
app installs the dependencies needed for the web application.
Specific plugins may require additional dependencies; refer to their documentation for details.

Beautiful Soup supports multiple parsers, and will use the best available one; for speed, install lxml.

Virtual environments

You should probably install reader inside a virtual environment; see this for how and why to do it.

Install reader

Use the following command to install reader, along with its required dependencies:

pip install reader

Use the following command to install reader with optional dependencies:

pip install 'reader[some-extra,...]'

Update reader

Use the following command to update reader (add any extras as needed):

pip install --upgrade reader

Living on the edge

If you want to use the latest reader code before it’s released, install or update from the master branch:

pip install --upgrade https://github.com/lemon24/reader/archive/master.tar.gz