Skip to content
This repository has been archived by the owner on Nov 10, 2017. It is now read-only.

Latest commit

 

History

History
71 lines (46 loc) · 2.05 KB

README.md

File metadata and controls

71 lines (46 loc) · 2.05 KB

This is a small web application to provide a front-end interface to validate whether ocds-formatted data is ocds compliant.

Note: this was deployed at http://ocds.open-contracting.org/validator but has now been replace by https://github.com/OpenDataServices/cove

Requirements

You will need:

  • git
  • pip
  • MySQL

Installation on Ubuntu 14.04.

$ sudo apt-get install git python-pip python-dev mysql-server libmysqlclient-dev 
$ sudo pip install virtualenv

Installation on OSX 10.8 with homebrew:

$ brew install git python mysql
$ pip install virtualenv

Install

This has been tested on Ubuntu 14.04 & OSX 10.8.

The whole application runs inside a virtualenv, but you do not have to manage it yourself, the dye commands handle this for you.

After cloning the repo, go to the deploy directory:

$ cd validator/validator/deploy

The bootstrap.py command sets up a virtualenv for us:

$ ./bootstrap.py

We use the deploy command to do the following:

  • sets up our sql database for the first time including creating a new username and password (this is why deploy wants your mysql root password)
  • links to the correct local settings files
  • does other deploy things (which are generally more relevant when deploying to server - building webassets etc.

To deploy (note it will ask you for your MySQL root password twice):

$ ./tasks.py deploy:dev

Run validator locally

Go into the django directory and use manage.py to run django:

$ ./manage.py runserver

./manage.py automatically runs validator inside the virtualenv that was setup by bootstrap.py

Run tests

py.test and pytest-django are used for testing validator. To run the tests use:

$ ./manage.py test

This automatically invokes pytest and you can pass all pytest arguments e.g.:

$ ./manage.py test --fixtures

Adding new requirements

To add new pip packages to validator, add them to deploy/pip_packages.txt. After doing this, run bootstrap.py again to update your virtualenv.