rss-reader 3.1

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 feed to html/pdf/epub for more comfortable reading

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.

Installation

1. Using pip

pip install rss-reader

2. Using Git and GitHub

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

Usage

IMPORTANT

rss-reader 3.1 no longer supports fb2 format and caching

Notice

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

Argument help

usage: __main__.py [-h] [--version] [--verbose] [-o {console,colorized,json,none}] [-c {json,html,pdf,epub}] [--convert-dir CONVERT_DIR] [--convert-file CONVERT_FILE] [-l LIMIT] source

Pure Python command-line RSS reader.

positional arguments:
  source                RSS source URL or a file path

optional arguments:
  -h, --help            show this help message and exit
  --version             print version info
  --verbose             output verbose status messages
  -o {console,colorized,json,none}, --output {console,colorized,json,none}
                        console output type
  -c {json,html,pdf,epub}, --convert {json,html,pdf,epub}
                        convert feed and save as a file
  --convert-dir CONVERT_DIR
                        convert output dir path instead of {HOME}/rss_reader/output
  --convert-file CONVERT_FILE
                        convert output filename
  -l LIMIT, --limit LIMIT
                        limit news topics if this parameter is provided

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