diff options
author | François Schmidts <francois.schmidts@gmail.com> | 2015-03-03 23:30:16 +0100 |
---|---|---|
committer | François Schmidts <francois.schmidts@gmail.com> | 2015-03-03 23:30:16 +0100 |
commit | 41cb78173636e0f6f463280afdf050583dbdb3dc (patch) | |
tree | 42224fe408d3048f210b565413feb34bfe08940c /documentation | |
parent | last fixes (diff) | |
parent | Typo. (diff) | |
download | newspipe-41cb78173636e0f6f463280afdf050583dbdb3dc.tar.gz newspipe-41cb78173636e0f6f463280afdf050583dbdb3dc.tar.bz2 newspipe-41cb78173636e0f6f463280afdf050583dbdb3dc.zip |
Merge remote-tracking branch 'origin/master' into evol/api
Conflicts:
bootstrap.py
pyaggr3g470r/models.py
pyaggr3g470r/notifications.py
pyaggr3g470r/rest.py
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/conf.py | 4 | ||||
-rw-r--r-- | documentation/index.rst | 3 | ||||
-rw-r--r-- | documentation/requirements.rst | 16 |
3 files changed, 20 insertions, 3 deletions
diff --git a/documentation/conf.py b/documentation/conf.py index b148de9d..00190f45 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -48,9 +48,9 @@ copyright = u'2015, Cédric Bonhomme' # built documents. # # The short X.Y version. -version = '6.0' +version = '6.2' # The full version, including alpha/beta/rc tags. -release = '6.0' +release = '6.2' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/documentation/index.rst b/documentation/index.rst index d01dc583..947612a1 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -7,12 +7,13 @@ Welcome to pyAggr3g470r's documentation! ======================================== -Deployment and configuration +Configuration and deployment ============================ .. toctree:: :maxdepth: 2 + requirements deployment Web services diff --git a/documentation/requirements.rst b/documentation/requirements.rst new file mode 100644 index 00000000..a3630144 --- /dev/null +++ b/documentation/requirements.rst @@ -0,0 +1,16 @@ +Requirements +============ + +The complete list of required Python modules is in the file +``requirements.txt``. + +The core technologies used are: + +* `Flask <http://flask.pocoo.org>`_ for the web backend; +* `asyncio <https://www.python.org/dev/peps/pep-3156/>`_ for the crawler; +* `SQLAlchemy <http://www.sqlalchemy.org>`_ for the data base. + +Python 3.4 is highly recommended, especially for the feed crawler. +The web server is working with Python 2.7 and Python 3. + +It is possible to connect your own crawler to the RESTful API. |