aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: d909d339485b1cd9bd36462ec993a85bac8880f1 (plain)
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
pyAggr3g470r
============

#### A simple Python news aggregator.

Presentation
------------
[pyAggr3g470r](https://bitbucket.org/cedricbonhomme/pyaggr3g470r/) is a news aggregator with a web interface
based on [Flask](http://flask.pocoo.org/). Articles are stored in a [MongoDB](http://api.mongodb.org/python/current/) base.

Features
------------
* articles are stored in a [MongoDB](http://www.mongodb.org/) database;
* favorite articles;
* share articles with Google +, Pinboard and reddit.

Requierements
-------------

Python >= 2.7. To install the required libraries:

    $ sudo pip install --upgrade -r requirements.txt

Configuration
-------------

You can use the script **initialization.py** to create your user.
Configuration is done via the file **conf/conf.cfg**.

    $ python initialization.py database_name firstname lastname email password
    $ cp conf/conf.cfg-sample conf/conf.cfg
    $ python runserver.py

Backup
------

If you want to backup your database:

    $ su
    $ /etc/init.d/mongodb stop
    $ cp /var/lib/mongodb/pyaggr3g470r.* ~

Donation
--------
If you wish and if you like pyAggr3g470r, you can donate via bitcoin 1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ.
Thank you!

License
-------
[pyAggr3g470r](https://bitbucket.org/cedricbonhomme/pyaggr3g470r/) is under [GPLv3](http://www.gnu.org/licenses/gpl-3.0.txt) license.

Contact
-------
[My home page](http://cedricbonhomme.org/).
bgstack15