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.0a2.dev4.tar.gz (20.8 kB view details)

Uploaded Source

Built Distribution

politico_civic_utils-1.0a2.dev4-py2-none-any.whl (27.2 kB view details)

Uploaded Python 2

File details

Details for the file politico-civic-utils-1.0a2.dev4.tar.gz.

File metadata

  • Download URL: politico-civic-utils-1.0a2.dev4.tar.gz
  • Upload date:
  • Size: 20.8 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.0a2.dev4.tar.gz
Algorithm Hash digest
SHA256 87a1cdc4522224c73e0a973c89fe04a78e6a5d42168376a3aeea84592f037871
MD5 21fda16a1dc01d7cde5377c3327ad3ce
BLAKE2b-256 2e46114d4b33ed5c9b10e0257ac5d9876da9c0eb581f723efd85733f83460c0a

See more details on using hashes here.

File details

Details for the file politico_civic_utils-1.0a2.dev4-py2-none-any.whl.

File metadata

  • Download URL: politico_civic_utils-1.0a2.dev4-py2-none-any.whl
  • Upload date:
  • Size: 27.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.0a2.dev4-py2-none-any.whl
Algorithm Hash digest
SHA256 8a32568b701ef274e4ad39e8936a02f9dcc94147a88fa54f8bdd3057fc7af65c
MD5 206cd060192e56d6a9f0039c9cd3a490
BLAKE2b-256 86eb0cbe7b1ec56fdd02aa65349ee31ef9bd717efc3b219b3493357e2ab4ecaa

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