skip to navigation
skip to content

Not Logged In

feedstail 0.4.1

A tail-f-like utility for feeds

Feedstail
=========

Feedstail is a tail-f-like utility for feeds. It monitor a feed and emits new entries.
Feedstail aim to be simple, hackable and compatible with rsstail_ its C brother.

.. _rsstail : http://www.vanheusden.com/rsstail/


License
-------

Feedstail is released under the terms of the `GNU General Public License v3`_ or later.

.. _GNU General Public License v3 : http://www.gnu.org/licenses/gpl-3.0.html


Get started
-----------

Use pip to install feedstail the easy way:

::

  $ pip install feedstail

Or retrieve the project with git and install it:

::

  $ git clone git://gitorious.org/feedstail/feedstail.git
  $ cd feedstail
  $ python setup.py install

Then, launch feedstail with the `identi.ca`_ feeds to test it:

::

  $ feedstail -u http://identi.ca/api/statuses/public_timeline.atom

.. _identi.ca : http://identi.ca/


Examples
--------

By default, feedstail will checkout the feeds every 15 minutes. If you
want to customize this interval you can use the ``i`` option.
The following example will retrieve feeds every 5 seconds:

::

  $ feedstail -u http://identi.ca/api/statuses/public_timeline.atom -i 5


The default output format may not be ok for you. You can specify your
own format using the ``f`` option. The given fields must be an
available property of the feed entries.
The following example will output the published date, the title and the link:

::

  $ feedstail -u http://identi.ca/api/statuses/public_timeline.atom -f "{published}: {title} - {link}"

This last example use the string formatting syntax appeared in the 2.6
version of Python.
However, feedstail aim to be 2.5 compatible so you can use the old
string formatting syntax:

::

  $ feedstail -u http://identi.ca/api/statuses/public_timeline.atom -f "%(published)s: %(title)s - %(link)s"


Feedstail compares the ``id`` element to find new entries. You can
choose another element of comparison with the ``k`` option.
The following example says to feedstail to use the title to find new
entries:

::

  $ feedstail -u http://identi.ca/api/statuses/public_timeline.atom -i 2 -k title



As feedstail is built above `feedparser`_, the available values of
format fields and keys can be found in `the documentation of the library`_.

.. _`feedparser` : http://feedparser.org/docs/
.. _`the documentation of the library` : http://feedparser.org/docs/


Contribute !
------------

  - Fork the project: `git://gitorious.org/feedstail/feedstail.git`_
  - Create your patch in a topic branch
  - Send pull requests or send your patches via e-mail

Don't forget to mark your commits by one of the following flag:

  - [enh]: Your commit add a notable enhancement, a new feature for instance
  - [fix]: Your commit is a bugfix
  - [doc]: Your commit improve the documentation
  - [mod]: Your commit bring general changes, matching neither of the above, like refactoring

.. _`git://gitorious.org/feedstail/feedstail.git` : git://gitorious.org/feedstail/feedstail.git
 
File Type Py Version Uploaded on Size
feedstail-0.4.1.tar.gz (md5) Source 2012-06-28 16KB
  • Downloads (All Versions):
  • 14 downloads in the last day
  • 110 downloads in the last week
  • 644 downloads in the last month