Browse Source

added dependencies sections to installation docs

master
Holger Frey 7 years ago
parent
commit
fe02f10cd8
  1. 51
      docs/installation.rst

51
docs/installation.rst

@ -8,7 +8,7 @@ Installation
From sources From sources
------------ ------------
The sources for Ordr2 can be downloaded from the `Github repo`_. The sources for Ordr2 can be downloaded from the `Git repo`_.
You can clone the public repository: You can clone the public repository:
@ -29,7 +29,7 @@ Once you have a copy of the source, you can install it with:
$ pip install . $ pip install .
.. _Github repo: https://git.cpi.imtek.uni-freiburg.de/holgi/ordr2 .. _Git repo: https://git.cpi.imtek.uni-freiburg.de/holgi/ordr2
Stable release (CURRENTLY NOT AVAILABLE) Stable release (CURRENTLY NOT AVAILABLE)
@ -51,3 +51,50 @@ you through the process.
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/ .. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
Dependencies
------------
These are the top-level packages that are needed by the webapp and why. They
rely propably on other packages as well.
pyramid
the framework for the web applicatoin
pyramid_debugtoolbar
debugging the web application in the browser
pyramid_jinja2
Jina2 templating engine for the pyramid web framework
pyramid_tm
automatic transaction management based on the request life cycle
SQLAlchemy
database abstraction
transaction
transaction management
waitress
wsgi server for developement
zope.sqlalchemy
required by pyramid_tm transaction binding
For running tests
~~~~~~~~~~~~~~~~~
pytest
for testing python projects
pytest-cov
test coverage report for pytest
pytest-runner
required for `test` command in setup.py
WebTest
run functional or integration tests on the web application