Cheshire3 Installation

Requirements / Dependencies

Cheshire3 requires Python 2.6.0 or later. It has not yet been verified as Python 3 compliant.

As of the version 1.0 release Cheshire3’s core dependencies should be resolved automatically by the standard Python package management mechanisms (e.g. pip, easy_install, distribute/setuptools).

However on some systems, for example if installing on a machine without network access, it may be necessary to manually install some 3rd party dependencies. In such cases we would encourage you to download the necessary Cheshire3 bundles from the Cheshire3 download site and install them using the automated build scripts included. If the automated scripts fail on your system, they should at least provide hints on how to resolve the situation.

If you experience problems with dependencies, please get in touch via the GitHub issue tracker or wiki, and we’ll do our best to help.

Additional / Optional Features

Certain features within the Cheshire3 Information Framework will have additional dependencies (e.g. web APIs will require a web application server). We’ll try to maintain an accurate list of these in the README file for each sub-package.

The bundles available from the Cheshire3 download site should continue to be a useful place to get hold of the source code for these pre-requisites.


The following guidelines assume that you have administrative privileges on the machine you’re installing on, or that you’re installing in a local Python install or a virtual environment created using virtualenv. If this is not the case, then you might need to use the --local or --user option . For more details, see:


Users (i.e. those not wanting to actually develop Cheshire3) have several choices:


  1. In GitHub, fork the Cheshire3 GitHub repository
  2. Locally clone your Cheshire3 GitHub fork
  3. Run python develop