Manage political geographic and spatial data, the POLITICO way.
Project description
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.
Quickstart
- 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
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
- 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
Developing the docs
Within a pipenv shell, navigate to the docs directory and run the docs development server.
$ make livehtml
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for politico-civic-geography-1.0a1.dev5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 065db84bb70a02dfc9d373af1c8fbb3aad7607322a661204bd7b117e7f8a4e91 |
|
MD5 | d9f3b40560c9d52d7c275ef1cd00957c |
|
BLAKE2b-256 | 9438c59712e44bfa2a0396ecdbb809556d027061ffb9b717e0319dd1fe11c9a3 |
Hashes for politico_civic_geography-1.0a1.dev5-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f6597a0a26db7df21ad7fffcac74bc77e43f7bd5bc50a087b0d8555018f32c10 |
|
MD5 | e955ea1d535ebc907343071ac76f96c4 |
|
BLAKE2b-256 | 2942c8849428681674c797ea866e7e6bdcfadf04b73a22818225d6311a26cc4b |