How to Upgrade Requirements

Work in progress

This page describes how requirements are installed. There are different instructions for production environments, developers and the docs. This page also describes how to update the requirements.

Install requirements

Production

In the CKAN root directory, run pip install -r requirements.txt.

Developers

First, install the requirements as you would do for a production environment. There are some additional requirements for testing and building the docs which can be installed with pip install -e .[dev].

Update requirements

1. Create a new, clean virtual environment mkvirtualenv --no-site-packages --distribute ckan to generate the production requirements file.

2. Have a look at the install_requires in the setup.py. See whether the package you want to update has the correct version.

3. Then install the required packages form the setup.py file with pip install -e ..

4. In order to check, whether there is a newer version, you can run pip-review --interactive. For more information, see http://nvie.com/posts/pin-your-packages/.

5. Once all the dependencies are installed, run CKAN and make sure that everything works as expected.

Now you can freeze the requirements with pip freeze > requirements.txt for production.