Skip to main content

Shared utilities for POLITICO Civic apps

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

politico-civic-utils-1.0a1.dev2.tar.gz (19.1 kB view details)

Uploaded Source

Built Distribution

politico_civic_utils-1.0a1.dev2-py2-none-any.whl (25.2 kB view details)

Uploaded Python 2

File details

Details for the file politico-civic-utils-1.0a1.dev2.tar.gz.

File metadata

  • Download URL: politico-civic-utils-1.0a1.dev2.tar.gz
  • Upload date:
  • Size: 19.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/2.7.16

File hashes

Hashes for politico-civic-utils-1.0a1.dev2.tar.gz
Algorithm Hash digest
SHA256 96449cf4bfbe7d5d92872136ebb1b18e5e78e8b7ed72e7cea077df31ab9bd26c
MD5 78c392956942d13925d5668a53ffdced
BLAKE2b-256 094b453f11ef1234e54f6fa81434777dfd1e94179182924287d39cef02ead920

See more details on using hashes here.

File details

Details for the file politico_civic_utils-1.0a1.dev2-py2-none-any.whl.

File metadata

  • Download URL: politico_civic_utils-1.0a1.dev2-py2-none-any.whl
  • Upload date:
  • Size: 25.2 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/2.7.16

File hashes

Hashes for politico_civic_utils-1.0a1.dev2-py2-none-any.whl
Algorithm Hash digest
SHA256 c3499fcbec11dc765a9fe3bb1b35c12cd096faff7bfb6f32351175d7a23c7bb9
MD5 0e5fb57938b52406091afbfffd386926
BLAKE2b-256 5f0a398d29be8ae7ffab6c9b7beef6fe15df9f8c6d4b44fb0111056fc1c43036

See more details on using hashes here.

Supported by

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