rss-reader 3.2

A simple CLI rss reader

Rss reader

What is this?

rss-reader is a command line utility that allows you to view RSS feeds

You can also convert RSS feeds to html/pdf/epub for more convenient reading

Command-line arguments, local and global INI configs, environment variables are supported

What is RSS?

RSS stands for “Really Simple Syndication,” or, depending on who you ask, “Rich Site Summary.” At it's heart, RSS is just simple text files with basic updated information—news pieces, articles, that sort of thing. That stripped-down content is usually plugged into what is called a “feed reader” or an interface that quickly converts the RSS text files into a stream of the latest updates from around the web.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

pre-commit usage is highly recommended

install hooks via pre-commit install -t=pre-commit -t=pre-push

License

MIT

Documentation

1. Installation
2. Usage
   1. Notes
   2. Examples
3. Config
   1. Info
      1. Config source priority
      2. Warning
   2. Command-line arguments
   3. INI configs
   4. Environment variables
      1. Using environment variables

Installation

Using pip

pip install rss-reader

Using Git and GitHub

git clone https://github.com/dhvcc/rss-reader.git
cd rss-reader
pip install .

Extras

You can install extra dependencies, such as speedups or dev

pip install rss-reader[dev]
# or
pip install .[speedups]

Usage

Notes

IMPORTANT rss-reader 3.1 no longer supports fb2 format and caching

You can mute console output with -o none. It may be useful if you want to convert only

Examples

Converting feed to html and muting console output. Feed is limited to 2 items

rss-reader https://feedforall.com/sample.xml --output none --convert html --limit 2

This will generate colorized console output and the feed will be also converted to epub

rss-reader /path/to/your/file.xml -o colorized -c epub

This will generate default console output and the feed will be converted to pdf and saved in /my/dir/filename.pdf

rss-reader /path/to/your/file.xml -c pdf --convert-dir /my/dir --convert-file filename.pdf

Config

Info

Config argument sources are prioritized

1. Command-line arguments
2. Local .rss-reader config
3. Environment variables
4. Global {HOME}/.rss-reader config

Warning

source, verbose, limit and version arguments can be set only as cli arguments

Command-line arguments

To view help on cli arguments you can run rss-reader --help

INI configs

Every argument is optional if config and will be grabbed from other source if not present The syntax for config is the following:

[rss-reader]
OUTPUT =
CONVERT =
CONVERT_DIR =
CONVERT_FILE =

Global config should be located in your home folder and named .rss-reader

Environment variables

Env vars should be prefixed with RSS_READER_, for example, RSS_READER_OUTPUT

Using environment variables

Windows

Linux