Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

POLITICO

politico-civic-geography

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.

Read the docs.

Quickstart

  1. Install the app.
$ pip install politico-civic-geography
  1. 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
  1. Migrate the database.
$ python manage.py migrate geography

Bootstrapping your database

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

Publishing geography to S3

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

Developing

Running a development server

Move into the example directory, install dependencies and run the development server with pipenv.

$ cd example
$ pipenv install
$ pipenv run python manage.py runserver
Setting up a PostgreSQL database
  1. Run the make command to setup a fresh database.
$ make database
  1. Add a connection URL to example/.env.
DATABASE_URL="postgres://localhost:5432/geography"
  1. Run migrations from the example app.
$ cd example
$ pipenv run python manage.py migrate
Developing the docs

Within a pipenv shell, navigate to the docs directory and run the docs development server.

$ make livehtml

About

Geography for civic databases.

Resources

License

Releases

No releases published

Packages

No packages published

Languages