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 -r dev-requirements.txt.

Upgrading requirements

Inside a virtualenv with only CKAN dependencies (created using mkvirtualenv --no-site-packages --distribute venv), do:

1. Install the requirements from the file with unpinned versions using: pip install -r requirements.in;

2. Install CKAN with python setup.py develop;

3. Run the tests and check if everything works well;

4. Run pip freeze > requirements.txt to save the new dependency versions;

5. Remove the CKAN dependency line;

6. Review the changes and make sure everything is OK. Make sure you understand every dependency change