p-e-w / krill Goto Github PK

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

Python 100.00%

krill's Introduction

Want news? Just `krill` it!

Krill are filter feeders. True to its namesake, krill 🍤 filters feeds. It is not picky about its diet, and will happily consume RSS, Atom, CDF and even Twitter 🐦 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 🔥 of clean, legible command line output.

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 📰 and updates from anywhere on the web. krill is the hacker's way of keeping up with the world. 🌐

Installation

krill requires Python 2.7+/3.2+ 🐍. If you have the pip package manager, all you need to do is run

pip install krill

either as a superuser or from a virtualenv environment.

Of course, you can also download the script directly from this repository, in which case you will need to install the dependencies Beautiful Soup (what a library! ⭐), feedparser, Blessings and 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 🚀 Twitter stream, printing only tweets that mention the New Horizons probe.

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 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

Released under the terms of the GNU General Public License, version 3

krill's People

Contributors

Stargazers

Watchers

krill's Issues

throws error with opml

This opml was geenrated by tinytinyrss

Traceback (most recent call last):
File "/usr/local/bin/krill", line 9, in
load_entry_point('krill==0.3.0', 'console_scripts', 'krill')()
File "/usr/local/lib/python2.7/dist-packages/krill-0.3.0-py2.7.egg/krill/krill.py", line 337, in main
Application(args).run()
File "/usr/local/lib/python2.7/dist-packages/krill-0.3.0-py2.7.egg/krill/krill.py", line 298, in run
self.update()
File "/usr/local/lib/python2.7/dist-packages/krill-0.3.0-py2.7.egg/krill/krill.py", line 272, in update
for item in self._get_stream_items(source):
File "/usr/local/lib/python2.7/dist-packages/krill-0.3.0-py2.7.egg/krill/krill.py", line 72, in get_feed_items
feed_data = feedparser.parse(xml)
File "/usr/lib/python2.7/dist-packages/feedparser.py", line 4014, in parse
saxparser.parse(source)
File "/usr/lib/python2.7/dist-packages/drv_libxml2.py", line 214, in parse
eltName,eltQName,attributesNSImpl)
File "/usr/lib/python2.7/dist-packages/feedparser.py", line 1809, in startElementNS
raise UndeclaredNamespace, "'%s' is not associated with a namespace" % givenprefix
feedparser.UndeclaredNamespace: 'dc' is not associated with a namespace

Windows 7

I was able to get fcntl.py working then next error "termios" is missing.

Maybe add a note that this won't work under Windows.

color configuration

It would be nice make krill theme configurable, I really like it, but the colors are... well, not of my liking. :)

Curses/Blessings unsupported on windows

Krill crashes on windows.

The root cause of the crash is that curses is not on windows machines.

The library you are using for terminal manipulation (blessings) has an open issue on github for this here.

It looks like you are only using this to color/format text in the terminal. It may be worth looking into colorama which is cross platform.

If I have time I might try and implement this myself.

Traceback:

Traceback (most recent call last):
  File "C:\Python34\lib\runpy.py", line 170, in _run_module_as_main
    "__main__", mod_spec)
  File "C:\Python34\lib\runpy.py", line 85, in _run_code
    exec(code, run_globals)
  File "C:\Python34\Scripts\krill.exe\__main__.py", line 5, in <module>
  File "C:\Python34\lib\site-packages\krill\krill.py", line 31, in <module>
    from blessings import Terminal
  File "C:\Python34\lib\site-packages\blessings\__init__.py", line 5, in <module>

    import curses
  File "C:\Python34\lib\curses\__init__.py", line 13, in <module>
    from _curses import *
ImportError: No module named '_curses'

Other than this minor issue I really like you code :)

Is it possible to use authentication?

I have an RSS feed that's generated by an issue tracker that I want to track with Krill. However the RSS feed in question requires authentication.

I didn't see any information in the docs about authentication. Is this possible, maybe via an opml file?

OPML i/o

https://en.m.wikipedia.org/wiki/OPML

Feed readers such as Feedly and Inoreader can import and export lists of feed subscriptions in OPML format. Would be nice to be able to get that data into krill quickly using an import tool.