rss-reader 1.4.0

A simple CLI rss reader

CLI RSS reader

CLI rss reader is a utility which makes it easy to read RSS feed from command line

What is RSS?

RSS stands for “really simple syndication,” or, depending on who you ask, “rich site summary.” At its 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

Use the package manager pip3 to install this RSS reader.

pip3 install rss-reader

or

You can download it manually and run python3 setup.py install in .../rss-reader-1.4.0/

Requirements

Python version 3.6 and later

Usage

usage: rss_reader [-h] [--version] [--json] [--verbose] [--limit LIMIT]
              [--date DATE] [--clear-cache] [--to-mobi] [--to-epub]
              [--to-fb2] [--to-html] [--to-pdf]
              source

Pure Python command-line RSS reader.

positional arguments:
  source         RSS URL

optional arguments:
  -h, --help     show this help message and exit
  --version      print version info
  --json         print result as JSON in stdout
  --verbose      output verbose status messages
  --limit LIMIT  limit news topics if this parameter provided
  --date DATE    print cached news from provided date
  --clear-cache  clear news cache
  --to-mobi    convert news to .mobi format and make a new file called
               news.mobi
  --to-epub    convert news to .epub format and make a new file called
               news.epub
  --to-fb2     convert news to .fb2 format and make a new file called
               news.fb2
  --to-html    convert news to .html format and make a new file called
               news.html
  --to-pdf     convert news to .pdf format and make a new file called
               news.pdf

JSON structure

{
    "Feed title": "(Feed title)",
    "News": [
        {
            "Title": "(News title)",
            "Link": "(News link)",
            "Publishing date": "(publishing date)",
            "Category": "(category)",
            "Description": "(description)",
            "Description links": [
                "(link)",
                "(link)",
                ...
            ],
            "Description images": [
                {
                    "Title": "(image title)",
                    "Link": "(image link)"
                },
                {
                    "Title": "(image title)",
                    "Link": "(image link)"
                },
                ...
            ]
        },
        {
            "Title": "(News title)",
            "Link": "(News link)",
            "Publishing date": "(publishing date)",
            "Category": "(category)",
            "Description": "(description)",
            "Description links": [
                "(link)",
                "(link)",
                ...
            ],
            "Description images": [
                {
                    "Title": "(image title)",
                    "Link": "(image link)"
                },
                {
                    "Title": "(image title)",
                    "Link": "(image link)"
                },
                ...
            ]
        },
        ...
    ]
}

Contributing

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

License

MIT