Dependencies: * Python v2.7+ (No Python 3 support yet -- want to help?) * _CoffeeScript v1.6+ * _Sass v3.2+ * _Compass v0.12+ * _ElasticSearch v0.19+
See the platform specific INSTALL.<platform>.rst files for more information about how to install the dependencies on any specific platform.
In the future, releases will include built versions of static assets which will eliminate the need for those who wish to integrate with their own Python web services but do not need to modify the front-end sources.
The project code itself is a pyramid application which can be integrated into any WSGI compatible framework and run on any WSGI web server (such as gunicorn or uWSGI). Until the project is ready for general testing it will not be installable from the Python Package Index. Instead, the application should be built in a virtual environment which can be set up as follows:
$ ./bootstrap
The command will set up the development environment and check for development dependencies. Warnings will be issued for missing dependencies. When this script runs successfully, the environment should be prepared. It is good practice to run this script whenever the source code changes, such as after pulling new commits from upstream, or checking out a new branch, which may have changed (for example: updated) requirements.
For building the static assets, requirements currently include CoffeeScript and Sass with Compass installed. These tools are widely available in package repositories. Check the platform-specific installation instructions for details.
For production use, the application will use UglifyJS and clean-css for minification needs. These are not required when running the project in a development configuration.