1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
.. pyAggr3g470r documentation master file, created by
sphinx-quickstart on Sat Sep 15 08:55:50 2012.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to pyAggr3g470r's documentation!
========================================
.. toctree::
:maxdepth: 2
Presentation
------------
pyAggr3g470r_ is a news aggregator with a web interface
based on CherryPy_. Articles are stored in a MongoDB_ base.
* `Ohloh page <http://www.ohloh.net/p/pyAggr3g470r>`_ of pyAggr3g470r;
* `Freecode page <http://freecode.com/projects/pyaggr3g470r>`_ of pyAggr3g470r
Features
--------
* articles are stored in a MongoDB_ database (local or remote);
* article searching;
* e-mail notification;
* export articles to HTML, EPUB, PDF or raw text;
* favorite articles;
* sharing with Diaspora, Google Buzz, Pinboard, Identi.ca, Digg, reddit, Scoopeo, Blogmarks and Twitter;
* generation of QR codes with URLs of articles.
Installation
------------
Requierements
~~~~~~~~~~~~~
Software required
`````````````````
* Python_ >= 3.2.3;
* MongoDB_ and PyMongo_ >= 1.9;
* feedparser_ >= 5.1.2 (for **feedgetter.py**, the RSS feed parser);
* CherryPy_ >= 3.2.2 and Mako_ (for **pyAggr3g470r.py**, the Web interface);
* BeautifulSoup_ >= 4.1.3 (automatically find a feed in a HTML page).
Optional module
```````````````
These modules are not required but enables more features:
* lxml and Genshi;
* Python Imaging Library for the generation of QR codes.
Not yet tested with Python 3.2. Anyway, if you want to install these modules:
.. code-block:: bash
$ sudo aptitude install python3.2-lxml python-genshi
Script of installation
~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: bash
sudo aptitude install python3-feedparser python3-bs4
sudo aptitude install python-pymongo python3-mako
wget http://download.cherrypy.org/cherrypy/3.2.2/CherryPy-3.2.2.tar.gz
tar -xzvf CherryPy-3.2.2.tar.gz
rm -f CherryPy-3.2.2.tar.gz
cd CherryPy-3.2.2/
sudo python setup.py install
cd ..
sudo rm -Rf CherryPy-3.2.2/
hg clone https://bitbucket.org/cedricbonhomme/pyaggr3g470r
cd pyaggr3g470r/
cp cfg/pyAggr3g470r.cfg-sample cfg/pyAggr3g470r.cfg
Setting
~~~~~~~
List of feeds
`````````````
Rename the file **./cfg/pyAggr3g470r.cfg-sample** to **./cfg/pyAggr3g470r.cfg**.
By default you don't have to edit this file (only to configure mail notification).
Then, indicate the feeds to retrieve in the file **./var/feed.lst**. One feed per line. For example :
.. code-block:: cfg
http://blog.cedricbonhomme.org/feed/
http://linuxfr.org/backend/news-homepage/rss20.rss
http://rss.slashdot.org/Slashdot/slashdot
http://theinvisiblethings.blogspot.com/feeds/posts/default
http://torvalds-family.blogspot.com/feeds/posts/default
http://www.python.org/channews.rdf
http://www.kde.org/dotkdeorg.rdf
http://feeds.feedburner.com/internetactu/bcmJ
http://www.april.org/fr/rss.xml
http://www.framablog.org/index.php/feed/atom
http://formats-ouverts.org/rss.php
http://lwn.net/headlines/newrss
http://kernelnewbies.org/RecentChanges?action=rss_rc&ddiffs=1&unique=1
Create a new user
`````````````````
Add a username and a password in the file **./var/password** separated by a semicolon, one per line.
The default user is *admin* with the password *admin*. The password should be hashed with the SHA1 function.
Mail notification
`````````````````
If you wish to stay tuned from new articles of a feed by email, you have to edit the configuration file:
* your mail address (address of the recipient of the news);
* a SMTP server;
* the address used by pyAggr3g470r to send the mail, and;
* the corresponding password.
.. code-block:: cfg
[MongoDB]
address = mongodb.alwaysdata.com
port = 27017
dbname = bob_pyaggr3g470r
user = bob
password = password_of_bob
[mail]
mail_from = pyAggr3g470r@no-reply.com
mail_to = address_of_the_recipient@example.com
smtp = smtp.example.com
username = your_mail_address@example.com
password = your_password
[misc]
diaspora_pod = joindiaspora.com
Then just click on "Stay tuned" for the desired feed(s) at the main page of pyAggr3g470r in your browser.
Launch
------
To launch pyAggr3g470r in a shell:
.. code-block:: bash
$ cd ~/pyaggr3g470r/source/
$ pyAggr3g470r start
Backup
------
If you want to backup your database:
.. code-block:: bash
$ su
$ /etc/init.d/mongodb stop
$ cp /var/lib/mongodb/pyaggr3g470r.* ~
Demo
----
* some `screen shots <http://picasaweb.google.com/cedric.photos/PyAggr3g470r>`_ of **pyAggr3g470r**;
* an old `video <http://youtu.be/Eyxpqn9Rpnw>`_ of pyAggr3g470r;
* an example of `HTML auto-generated archive <http://cedricbonhomme.org/news/>`_.
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.
Contact
-------
`My home page <http://cedricbonhomme.org/>`_.
.. _Python: http://python.org/
.. _pyAggr3g470r: https://bitbucket.org/cedricbonhomme/pyaggr3g470r/
.. _feedparser: http://feedparser.org/
.. _MongoDB: http://www.mongodb.org/
.. _PyMongo: https://github.com/mongodb/mongo-python-driver
.. _CherryPy: http://cherrypy.org/
.. _Mako: http://www.makotemplates.org/
.. _BeautifulSoup: http://www.crummy.com/software/BeautifulSoup/
.. _GPLv3: http://www.gnu.org/licenses/gpl-3.0.txt
|
