Hippodamus

This repository is about Open Addresses' publishing scripts that create the downloadable versions of Open Addresses' database. It is named "hippodamus", after Hippodamus of Miletus: an ancient Greek architect, urban planner, physician, mathematician, meteorologist and philosopher commonly is considered to be the "father" of urban planning. Hippodamus is part of the solution Open Addresses deployed for the Alpha stage of our services. Read about Hippodamus here or learn about Open Addresses in general here.

Hippodamus is a Ruby script that exports the MongoDB database from Theodolite and uploads it to Amazon S3.

Setup

Clone the repo:

git clone git@github.com:OpenAddressesUK/hippodamus.git

Bundle:

bundle install

Add a file named .env with the following:

WIKIPEDIA_URL: https://en.wikipedia.org/wiki/List_of_postcode_areas_in_the_United_Kingdom
MONGOLAB_URI: {The URI for connecting to the mongodb instance}
AWS_ACCESS_KEY: {Your Amazon Webservices access key}
AWS_SECRET_ACCESS_KEY: {Your Amazon Webservice secret access key}
AWS_BUCKET: {The bucket you intend to store the dumps in}

Run the following command:

rake hippodamus:upload

Licence

This code is open source under the MIT license. See the LICENSE.md file for full details.