Development guide

Install the requirements

Install the following:

  1. Python
  2. PIP
  3. VirtualEnv
  4. virtualenvwrapper

Install in a virtualenv

Create a virtualenv using Python 3 (an isolated Python environment):

$ mkvirtualenv -p /usr/local/bin/python3 ievv_opensource

Install the development requirements:

$ pip install -r requirements.txt

Note

Whenever you start a new shell where you need to use the virtualenv we created with mkvirtualenv above, you have to run:

$ workon ievv_opensource

Build the docs

Enable the virtualenv, and run:

$ ievv docs --build --open

Create a development database

Enable the virtualenv, and run:

$ ievv recreate_devdb

Running tests

To run the tests, we need to use a different settings file. We tell ievvtasks to do this using the DJANGOENV environent variable:

$ DJANGOENV=test python manage.py test