Metadata-Version: 1.0
Name: feedstail
Version: 0.0.1
Summary: A tail-f-like utility for feeds
Home-page: https://gitorious.org/feedstail/feedstail
Author: Romain Gauthier
Author-email: romain.gauthier@masteri2l.org
License: GNU General Public License v3
Description: 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 url:
        
        ::
        
          $ feedstail -u http://identi.ca/api/statuses/public_timeline.atom -f "{published}: {title} - {url}"
        
        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
        
        
        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
        
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.6
Classifier: Topic :: Utilities
