.. -*-restructuredtext-*-

============
pyAggr3g470r
============

.. Use headers in this order #=~-_

:toc: yes
:symrefs: yes
:sortrefs: yes
:compact: yes
:subcompact: no
:rfcedstyle: no
:comments: no
:inline: yes
:private: yes

:author: Cédric Bonhomme
:contact: http://cedricbonhomme.org/


Presentation
------------
pyAggr3g470r is a multi-threaded news aggregator with a web interface
based on CherryPy. Articles are stored in a SQLite base.



Features
------------
* articles are stored in a SQLite database;
* find an article with history;
* e-mail notification;
* export articles to HTML, EPUB, PDF or raw text;
* mark or unmark articles as favorites;
* share articles with Diaspora, Google Buzz, Pinboard, delicious, Identi.ca, Digg, reddit, Scoopeo, Blogmarks and Twitter;
* generation of QR code with the content or URL of an article. So you can read an article later on your smartphone (or share with friends).



Requierements
-------------
Software required
~~~~~~~~~~~~~~~~~
* Python 2.7.*
* SQLite
* feedparser (http://feedparser.org/)
* CherryPy (version 3 and up)
* BeautifulSoup


Optional module
~~~~~~~~~~~~~~~
These modules are not required but provides better features:
* lxml and Genshi;
* Python Imaging Library for the generation of QR codes;
* Gamin, detect changes in the database in a better way.


If you want to install these modules:

sudo aptitude install python-gamin python-lxml python-genshi


Donnation
---------
If you wish and if you like pyAggr3g470r, you can donate via bitcoin. My bitcoin address: 1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ
Thank you!



License
------------
pyAggr3g470r is under GPLv3 license.
http://www.gnu.org/licenses/gpl-3.0.txt