aboutsummaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
authorCédric Bonhomme <cedric@cedricbonhomme.org>2015-02-27 07:52:19 +0100
committerCédric Bonhomme <cedric@cedricbonhomme.org>2015-02-27 07:52:19 +0100
commit1894cfd312d4bd1c51b9ee63f25792f14dcfc665 (patch)
tree2ad5a74b1b9de140d4c587fb1beb7afcdd827373 /documentation
parentRelease 6.2. The system of email notifications for new articles has been remo... (diff)
downloadnewspipe-1894cfd312d4bd1c51b9ee63f25792f14dcfc665.tar.gz
newspipe-1894cfd312d4bd1c51b9ee63f25792f14dcfc665.tar.bz2
newspipe-1894cfd312d4bd1c51b9ee63f25792f14dcfc665.zip
Added a section about the requirements to the documentation.
Diffstat (limited to 'documentation')
-rw-r--r--documentation/index.rst3
-rw-r--r--documentation/requirements.rst16
2 files changed, 18 insertions, 1 deletions
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.
bgstack15