Manage political geographic and spatial data, the POLITICO way.
Creates a complete set of political geometries as topojson for export to AWS S3 or to interact with in your database.
- Install the app.
$ pip install politico-civic-geography
- Add the app to your Django project and configure settings.
INSTALLED_APPS = [
# ...
"rest_framework",
"geography",
]
#########################
# geography settings
CENSUS_API_KEY = ""
GEOGRAPHY_AWS_ACCESS_KEY_ID = ""
GEOGRAPHY_AWS_SECRET_ACCESS_KEY = ""
GEOGRAPHY_AWS_S3_BUCKET = ""
GEOGRAPHY_AWS_REGION = "us-east-1" # default
GEOGRAPHY_AWS_S3_UPLOAD_ROOT = "elections" # default
GEOGRAPHY_AWS_ACL = "public-read" # default
GEOGRAPHY_AWS_CACHE_HEADER = "max-age=3600" # default
GEOGRAPHY_API_AUTHENTICATION_CLASS = "rest_framework.authentication.BasicAuthentication" # default
GEOGRAPHY_API_PERMISSION_CLASS = "rest_framework.permissions.IsAdminUser" # default
GEOGRAPHY_API_PAGINATION_CLASS = "geography.pagination.ResultsPagination" # default
- Migrate the database.
$ python manage.py migrate geography
civic-geography can bootstrap a database of US national, state and county data for you from U.S. Census cartographic boundary files, creating simplified topojson geography. Just run it!
$ python manage.py bootstrap_geography
Use the --help
flag to see additional options.
Note: In order to create simplified geography, you must have topojson installed and available via command line on your machine. You can install it via npm.
$ npm install -g topojson
You can publish your geometries as topojson to an S3 bucket with this command. Give it a state FIPS code to bake out the geometry for that state, or use :code:00
to bake all states.
$ python manage.py bake_geography 00
Move into the example directory, install dependencies and run the development server with pipenv.
$ cd example
$ pipenv install
$ pipenv run python manage.py runserver
- Run the make command to setup a fresh database.
$ make database
- Add a connection URL to
example/.env
.
DATABASE_URL="postgres://localhost:5432/geography"
- Run migrations from the example app.
$ cd example
$ pipenv run python manage.py migrate
Within a pipenv shell, navigate to the docs directory and run the docs development server.
$ make livehtml