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. Run pip-review --interactive and choose which dependencies you'd like to upgrade (only one at a time);

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

3. If everything went OK, run pip-dump to save the new dependencies' versions into our *-requirements.txt files;

4. Review the changes and make sure everything is OK. Sometimes pip-dump adds CKAN itself as a requirement;

5. Double-check if a new version doesn't conflicts with whatever is in setup.py, and upgrade the versions there as well.