iamaziz / TermFeed

A simple terminal feed reader.
MIT License
257 stars 19 forks source link
feed news-feed reader rss-reader terminal

TermFeed

PyPI version

Terminal Feed is a minimal feed reader for the terminal (without curses).

To read, preview, open, store, or delete your favorite RSS feeds from the command line.

Why?

If 1) you are a terminal addict, and 2) you want to stay up to date with the outside world by reading quick feed and summaries WITHOUT having to leave your terminal; then TermFeed is for you. These are the main reasons I created TermFeed.

Usage

$ feed

$ feed <RSS-LINK>

$ feed -b

$ feed -t

$ feed -t <CATEGORY>

$ feed -a <RSS-LINK>

$ feed -a <RSS-LINK> <CATEGORY>

$ feed -d <RSS-LINK>

$ feed -D <category>

$ feed -R

Features (what you can do?)

Examples

Default browsing

default

Browse by topic

browse topics

Update library (Add or delete links)

add delete

See the avaiable topics and RSS links in your library:

list topics

Help See $ feed -h for detailed usage.

TermFeed 0.0.8

Usage:
    feed
    feed <rss-url>
    feed -b
    feed -a <rss-url> [<category>]
    feed -d <rss-url>
    feed -t [<category>]
    feed -D <category>
    feed -R
    feed (-h | --help)
    feed --version

Options:
                  List feeds from the default category 'General' of your library.
    <URL>         List feeds from the provided url source.
    -b            Browse feed by category avaialble in the database file.
    -a URL        Add new url <rss-url> to database under [<category>] (or 'General' otherwise).
    -d URL        Delete <rss-url> from the database file.
    -t            See the stored categories in your library, or list the URLs stored under <category> in your library.
    -D TOPIC      Remove entire cateogry (and its urls) from your library.
    -R            Rebuild the library from the url.py
    -h --help     Show this screen.

Installation

1) from PyPI repository:

$ pip install TermFeed

2) from the source distribution,

download and unpack the zipped folder, then:

$ cd TermFeed
$ python setup.py install

Uninstall

$ pip uninstall TermFeed

I use a data file (.termfeed.db) as a mini-database to maintain the RSS URLs. This file is created at the home directory (e.g. $HOME/.termfeed.db), delete it as well.

Remember, you may need to run these commands as an admin e.g. $ sudo ...

Dependencies

Miscellaneous

Author