2025 Python Packaging Survey is now live!  Take the survey now

Shared utilities for POLITICO Civic apps

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for ajv from gravatar.com ajv Avatar for brizandrew from gravatar.com brizandrew Avatar for POLITICO from gravatar.com POLITICO

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers
Report project as malware

Project description

POLITICO

politico-civic-utils

Quickstart

  1. Install the app.
$ pip install politico-civic-utils
  1. Add the app to your Django project and configure settings.
INSTALLED_APPS = [
    # ...
    'rest_framework',
    'civic_utils',
]

#########################
# civic_utils settings

CIVIC_UTILS_SECRET_KEY = ''
CIVIC_UTILS_AWS_ACCESS_KEY_ID = ''
CIVIC_UTILS_AWS_SECRET_ACCESS_KEY = ''
CIVIC_UTILS_AWS_REGION = ''
CIVIC_UTILS_AWS_S3_BUCKET = ''
CIVIC_UTILS_CLOUDFRONT_ALTERNATE_DOMAIN = ''
CIVIC_UTILS_S3_UPLOAD_ROOT = ''

Developing

Running a development server

Developing python files? Move into example directory and run the development server with pipenv.

$ cd example
$ pipenv run python manage.py runserver

Developing static assets? Move into the pluggable app's staticapp directory and start the node development server, which will automatically proxy Django's development server.

$ cd civic_utils/staticapp
$ gulp

Want to not worry about it? Use the shortcut make command.

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page