Installation and Setup¶

Requirements¶

• Python >= 2.7, with pip and virtualenv
• PostgreSQL >= 8.4
• RabbitMQ >= 2.6.1
• Apache Solr >= 4.0.0

Installation¶

First, check out the source code from the repository, e.g. via git on the command line:

$ git clone http://github.com/openspending/openspending.git
$ cd openspending

We also highly recommend you use a virtualenv to isolate the installed dependencies from the rest of your system.:

$ virtualenv ./pyenv --distribute

Now activate the environment. Your prompt will be prefixed with the name of the environment.:

$ source ./pyenv/bin/activate

Ensure that any in shell you use to complete the installation you have run the preceding command.

Having the virtualenv set up, you can install OpenSpending and its dependencies. This should be pretty painless. Just run:

$ pip install -r requirements.txt -e .

Additionally to the core repository, you will need to check out two auxilliary repositories and symlink them into OpenSpending. The repos contain the JavaScript components and the help system content for the site. The following instructions will download and link in the JS files:

$ git clone http://github.com/openspending/openspendingjs.git
$ ln -s openspendingjs openspending/ui/public/static/openspendingjs

The content parts of OpenSpending are built as a separate Jekyll project. For instructions on how make changes to the content, please refer to https://github.com/openspending/dotorg. If you want to develop the core application, you can use the live content from content.openspending.org instead.

You will also need to install python bindings for your database. For example, for Postgresql you will want to install the psycopg2 library:

$ pip install psycopg2

Create a database if you do not have one already. We recommend using Postgres but you can use anything compatible with SQLAlchemy. For postgres you would do:

$ createdb -E utf-8 --owner {your-database-user} openspending

Having done that, you can copy configuration templates:

$ cp development.ini_tmpl development.ini

Edit the configuration files to make sure you’re pointing to a valid database URL is set:

# TCP
openspending.db.url = postgresql://{user}:{pass}@localhost/openspending

or

# Local socket
openspending.db.url = postgresql:///openspending

Initialize the database:

$ ostool development.ini db init

Generate the help system documentation (this is used by the front-end and must be available, developer documents are separate). The output will be copied to the web applications template directory:

$ git submodule init && git submodule update
$ (cd doc && make clean html)

Compile the translations:

$ python setup.py compile_catalog

Run the application:

$ paster serve --reload development.ini

In order to use web-based importing and loading, you will also need to set up the celery-based background daemon. When running this, make sure to have an instance of RabbitMQ installed and running and then execute:

$ paster celeryd development.ini

You can validate the functioning of the communication between the backend and frontend components using the ping action:

$ curl -q http://localhost:5000/__ping__ >/dev/null

This should result in “Pong!” being printed to the background daemon’s console.

Setup Solr¶

Create a configuration home directory to use with Solr. This is most easily done by copying the Solr example configuration from the Solr tarball, and replacing the default schema with one from OpenSpending.:

$ cp -R apache-solr-4.1.0/* ./solr/
$ ln -sfT <full path to openspending>/solr/openspending_schema.xml ./solr/example/solr/conf/schema.xml

Start Solr with the full path to the folder as a parameter:

$ (cd solr/example && java -Dsolr.velocity.enabled=false -jar start.jar)

$ cp test.ini_tmpl test.ini

$ nosetests

$ ostool development.ini csvimport --model https://dl.dropbox.com/u/3250791/sample-openspending-model.json http://mk.ucant.org/info/data/sample-openspending-dataset.csv
$ ostool development.ini solr load openspending-example

UPDATE "account" SET admin = true WHERE "name" = 'username';