Builds are handled by Travis CI at https://travis-ci.org/open-ods/open-ods
Chat with us on Gitter! https://gitter.im/open-ods/open-ods
Latest Data File
The current Postgres database dump is openods_015_sep17_001.dump and can be downloaded from:
- Python 3.6+
pip install -g virtualenv
- PostgreSQL (Postgres.app is simple for development on OSX)
- Heroku Toolbelt - Helpful if you're going to use Heroku to host OpenODS
- Download Docker (Useful if you intend to use Docker!)
Clone this repository to your local machine
$ git clone https://github.com/open-ods/open-ods.git
In the terminal, navigate to the newly cloned repository on your machine
$ cd ~/Source/open-ods
Create a Python3 Virtualenv
$ virtualenv -p python3 openods
Check that python3 is installed properly by running
pythonand checking the version number displayed.
$ python --version Python 3.6.1
Activate the virtualenv
$ source env/bin/activate
Install libmemcached (for caching using flask-heroku-cacheify)
On OSX, you can use homebrew to easily install libMemcached
$ brew install libmemcached
On CentOS, you can use yum to install libmemcached and zlib
sudo yum install zlib-devel libmemcached-devel
If you're using another OS you will have to refer to appropriate instructions for your OS.
Install the project dependencies from the
$ pip install -r requirements-dev.txt
requirements-dev.txtcontains a list of all dependencies including those needed during the development process.
When deploying to production, you would use the
requirements.txtfile to install dependencies.
Now follow this guide to import the OpenODS data into your local database instance:
Assuming all steps have completed successfully, you should be able to test that you can run OpenODS using the built-in Flask development server.
From the project root, run:
$ python run.py
Database URL: postgresql://openods:openods@localhost:5432/openods Cache Timeout: 30 APP Hostname: http://localhost:5000/api API Path: /api DEBUG: False * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)
To get an instance of OpenODS running in Docker, follow this README
Source Data Attribution
Organisation Data Service, Health and Social Care Information Centre, licenced under the Open Government Licence v2.0 - Open Government Licence
More information on the Organisation Data Service can be found on the HSCIC website
This project is licensed under GNU GPL v3.
Copyright (c) 2017 Matt Stibbs and Tony Yates