https://github.com/p-e-w/krill

:newspaper: The hacker's way of keeping up with the world (NO LONGER MAINTAINED)
https://github.com/p-e-w/krill

Last synced: about 2 months ago
JSON representation

:newspaper: The hacker's way of keeping up with the world (NO LONGER MAINTAINED)

• Host: GitHub
• URL: https://github.com/p-e-w/krill
• Owner: p-e-w
• Archived: true
• Created: 2015-07-19T15:33:22.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-06-08T01:38:39.000Z (over 7 years ago)
• Last Synced: 2024-09-20T03:18:27.044Z (3 months ago)
• Language: Python
• Homepage:
• Size: 419 KB
• Stars: 803
• Watchers: 28
• Forks: 34
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• my-awesome-starred - krill - :newspaper: The hacker's way of keeping up with the world. (Python)

README

        
[![PyPI](https://img.shields.io/pypi/v/krill.svg)](https://pypi.python.org/pypi/krill) ![Python versions](https://img.shields.io/pypi/pyversions/krill.svg) ![krill rocks](https://img.shields.io/badge/krill-rocks-ff69b4.svg)

# Want news? Just `krill` it!

[Krill](https://en.wikipedia.org/wiki/Krill) are [*filter feeders*](https://en.wikipedia.org/wiki/Filter_feeder). True to its namesake, `krill` :fried_shrimp: filters feeds. It is not picky about its diet, and will happily consume **RSS, Atom, CDF** and even **Twitter** :bird: feeds (*no credentials required!*). It aggregates feed items from all sources you specify, filters out those that interest you, and displays them as a **live stream** :fire: of clean, legible command line output.

![Screenshot](screenshot.png)

`krill` is beautifully minimal. `krill` is extremely easy to set up and use, and runs anywhere Python runs. `krill` is a refreshingly different way of consuming news :newspaper: and updates from anywhere on the web. **`krill` is the hacker's way of keeping up with the world.** :globe_with_meridians:

## Installation

`krill` requires [Python](https://www.python.org/) 2.7+/3.2+ :snake:. If you have the [pip](https://pip.pypa.io) package manager, all you need to do is run

```

pip install krill

```

either as a superuser or from a [virtualenv](https://virtualenv.pypa.io) environment.

Of course, you can also [download the script](krill/krill.py) directly from this repository, in which case you will need to install the dependencies [Beautiful Soup](http://www.crummy.com/software/BeautifulSoup/) (*what a library!* :star:), [feedparser](https://github.com/kurtmckee/feedparser), [Blessings](https://github.com/erikrose/blessings) and [Requests](https://github.com/kennethreitz/requests) manually.

## Usage

### Command line

```

krill [-h] [-s URL [URL ...]] [-S FILE] [-f REGEX [REGEX ...]]

      [-F FILE] [-u SECONDS]

  -s URL [URL ...], --sources URL [URL ...]

                        URLs to pull data from

  -S FILE, --sources-file FILE

                        file from which to load source URLs (OPML format

                        assumed if filename ends with ".opml")

  -f REGEX [REGEX ...], --filters REGEX [REGEX ...]

                        patterns used to select feed items to print

  -F FILE, --filters-file FILE

                        file from which to load filter patterns

  -u SECONDS, --update-interval SECONDS

                        time between successive feed updates (default: 300

                        seconds, 0 for single pull only)

```

### Example

```

krill -s "https://twitter.com/nasa" -f "new ?horizons"

```

will follow NASA's :rocket: Twitter stream, printing only tweets that mention the [*New Horizons* probe](https://en.wikipedia.org/wiki/New_Horizons).

`krill` automatically determines whether to treat a web document as a Twitter or an XML feed. If multiple sources and/or filters are loaded from a file with the `-S` and `-F` tags, each must be on a separate line (except if the sources file uses the [OPML](https://en.wikipedia.org/wiki/OPML) format, in which case all `xmlUrl` attributes are loaded). Empty lines and lines starting with `#` (comments) are ignored.

Any URL format accepted by the Requests library is supported. In particular, feeds requiring (basic) HTTP authentication can be accessed by supplying credentials in the URL string with `https://user:[email protected]/feed`.

Inline and file specifications may be combined freely. If more than one filter is given, items matching *any* of the filters are printed. If no filter is given, all items are printed.

## License

Copyright © 2015 Philipp Emanuel Weidmann ()

Released under the terms of the [GNU General Public License, version 3](https://gnu.org/licenses/gpl.html)