Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
webisteme committed Nov 29, 2016
1 parent 6f61a42 commit 3c4f346
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,30 @@ several operations for querying data inside JSONB fields.

See: https://docs.djangoproject.com/en/1.10/ref/contrib/postgres/fields/#containment-and-key-operations

## Usage

python manage.py transformap -i jobs/jobfile.json

Admin interface: /admin
API URL: /places-api/
New jobs should be created as .YAML files in jobs/

## Misc

ETL business logic: places/management/commands
REST API configuration: places/api.py

## Deployment

For development, testing or demo purposes, use the Django development server:

python manage.py runserver 0.0.0.0:9000

Navigate to http://localhost:9000 ...

- /admin for the Admin area
- /places-api for the REST API interface
- /map-instance/MAP-INSTANCE-ID for the GEOJSON API

For production use, deploy Django using WSGI. See:
https://docs.djangoproject.com/en/1.10/howto/deployment/wsgi/

## Usage

To run a job, create a YAML job file in /jobs, then:

python manage.py transformap -i jobs/jobfile.yaml

This fetch and save the partner's data to the database.

0 comments on commit 3c4f346

Please sign in to comment.