Developing

Here are some details about developing the Geomancer API.

Getting the code

Make sure you have Git installed, and then from the command line:

$ git clone [email protected]:GeomancerProject/geomancer-api.git

That will download the full code repository into a directory named geomancer-api.

Dev server

The Geomancer API rides on Google App Engine Python 2.7 runtime, so you'll need to download and install the latest Python SDK.

It's useful adding the SDK to your PATH by adding the following line to your ~/.bashrc or ~/.bash_profile:

export PATH=$PATH:/your/path/to/google_appengine_sdk

App Engine ships with a local development server. At the command line:

$ cd geomancer-api
$ dev_appserver.py --clear_search_index --high_replication --use_sqlite -c .

Boom! It's now running locally at http://localhost:8080 and you get an admin console at http://localhost:8080/_ah/admin.

Authentication

Geomancer rides on Google APIs (e.g., Prediction) and it needs to bootstrapped with credentials by accessing http://localhost:8080/admin/oauth. Make sure you login as administrator and then click "Allow access".

When that's done, you can hit the API!

http://localhost:8080/api/georef?q=berkeley

Deploying to App Engine

To deploy to App Engine:

$ cd geomancer-api
$ app_cfg.py update .

That will upload all the code to the version specified in the app.yaml file. To specify a different version:

$ cd geomancer-api
$ app_cfg.py update -V foo .

And it will be available at http://foo.geomancer-api.appspot.com.