More on Installation

To install Diderot one can simply

$ pip install diderot

We strongly recomend the use of virtualenv (with virtualenvwrapper) to separate multiple projects environments, Python versions, library versions, etc.

Running tests locally

If you want to clone diderot repository and run all the tests, first install all libraries for running it.

$ mkvirtualenv diderot
$ make install

For running functional and unit tests:

$ make test

For running only unit tests:

$ make unit

For running only functional tests:

$ make functional

For running only acceptance tests:

$ make acceptance

Compiling documentation

To create this documentation you must first install the required libraries (such as sphinx) for compiling it into HTML files.

$ cd docs
$ make install

To compile the documentation:

$ make run

This will compile the documentation and open it in your favorite browser. To compile the documentation and open in a browser in two steps:

$ make html
$ make open

This is useful to check if there is compiling errors before opening the documentation.