nidico / policycompass-services

web services for the policy compass frontend

Policy Compass Services

Web Services for the Policy Compass

Manual

This manual is tested under Ubuntu 14.04!

Requirements

Python 3 should be already installed, but make sure with the following command:

  python3

Install the following packages:

  apt-get install python-virtualenv python3-dev libpq-dev

Install PostgreSQL:

  apt-get install postgresql

Installation

Create a new directory for the project

  mkdir services

Create a Python Virtual Environment with Python 3 and activate it

  virtualenv services --python=python3
  cd services
  source bin/activate

Clone the repository including submodules
Note: The submodule are configured for use with SSH, so configure your access to GitHub: https://help.github.com/articles/generating-ssh-keys

  git clone git@github.com:policycompass/policycompass-services.git
  cd policycompass-services
  git submodule init
  git submodule update
  git submodule foreach git checkout master

Install the Requirements

  pip install -r requirements.txt

Create a local settings file

  cp config/settings.sample.py config/settings.py

Edit the settings.py according to your needs. See: https://docs.djangoproject.com/en/1.6/ref/settings/#databases
Initialize the Database

	python manage.py syncdb
	python manage.py migrate
	python manage.py loaddata metrics users references

Start the application

	python manage.py runserver

Browse for example to: http://localhost:8000/api/v1/metrics

About

web services for the policy compass frontend