https://github.com/iamaziz/TermFeed

A simple terminal feed reader.
https://github.com/iamaziz/TermFeed

feed news-feed reader rss-reader terminal

Last synced: about 1 month ago
JSON representation

A simple terminal feed reader.

• Host: GitHub
• URL: https://github.com/iamaziz/TermFeed
• Owner: iamaziz
• License: mit
• Created: 2015-09-09T04:31:10.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-06-12T21:56:57.000Z (almost 2 years ago)
• Last Synced: 2024-05-12T06:02:43.486Z (11 months ago)
• Topics: feed, news-feed, reader, rss-reader, terminal
• Language: Python
• Size: 349 KB
• Stars: 254
• Watchers: 11
• Forks: 18
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome-github-stars - iamaziz/TermFeed - A simple terminal feed reader. (Python)

README

        
TermFeed

====

[![PyPI version](https://badge.fury.io/py/termfeed.svg)](http://badge.fury.io/py/termfeed)

**Term**inal **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`

- browse latest feed from your favorite rss sources (links stored under the default category `General`).

`$ feed `

- browse latest feed from the single link `` provided.

- e.g. `$ feed https://news.ycombinator.com/rss`

`$ feed -b`

- browse latest feeds by category of your library.

`$ feed -t`

- list the topics stored in your library.

`$ feed -t `

- list the URLs stored under `` in your library.

`$ feed -a `

- add new link to your rss library.

`$ feed -a  `

- add new link to your rss library under ``.

`$ feed -d `

- delete a link from your rss library.

`$ feed -D `

- Remove entire category (with its URLs) from library.

`$ feed -R`

- rebuild the library from `urls.py`

### Features (what you can do?)

- List feeds from different sources (stored in your library) with colorful text.

- Preview a short summary of a selected feed.

- Jump to (optionally) the source page of a feed in default browser.

- Store new (or delete) RSS URLs in (from) your library under a specific topic or under the default tag `General`.

### Examples

Default browsing

![default](http://i.imgur.com/CXFFIaF.gif?1)

Browse by topic

![browse topics](http://i.imgur.com/J09EFVv.gif?1)

Update library (Add or delete links)

![add delete](http://i.imgur.com/wcHdK4l.gif?1)

See the avaiable topics and RSS links in your library:

![list topics](http://i.imgur.com/98DM6US.gif?1)

Help

See `$ feed -h` for detailed usage.

```

TermFeed 0.0.8

Usage:

    feed

    feed 

    feed -b

    feed -a  []

    feed -d 

    feed -t []

    feed -D 

    feed -R

    feed (-h | --help)

    feed --version

Options:

                  List feeds from the default category 'General' of your library.

             List feeds from the provided url source.

    -b            Browse feed by category avaialble in the database file.

    -a URL        Add new url  to database under [] (or 'General' otherwise).

    -d URL        Delete  from the database file.

    -t            See the stored categories in your library, or list the URLs stored under  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](https://github.com/iamaziz/TermFeed/archive/master.zip), 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

- [feedparser](https://pypi.python.org/pypi/feedparser)

#### Miscellaneous

- Tested on OS X and Linux.

- Supports Python 2.7 and Python 3.4

- The URLs in `urls.py` are complementary. They will be added to your library at `$HOME/.termfeed.db` when you run TermFeed (`$ feed`) for the first time. You may delete them all and have your own list instead.

- [Instant RSS Search](http://ctrlq.org/rss) is a nice search engine for searching RSS feeds.

### Author

- Aziz Alto