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.dev8.tar.gz (19.1 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 2

File details

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

File metadata

  • Download URL: politico-civic-utils-1.0a1.dev8.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.dev8.tar.gz
Algorithm Hash digest
SHA256 9275c44b6a53a1cf95c33fbe2be89268c40de13cf8ee20e7da13cb8a4abad606
MD5 b825c6f7c617c760dfd8c523f839395e
BLAKE2b-256 b0cc2a577309f7aa0780723acec56f5c5e7d080c38aa0d65b686cf91affe47b7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: politico_civic_utils-1.0a1.dev8-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.dev8-py2-none-any.whl
Algorithm Hash digest
SHA256 5350f92b3cf6bd31c02599d732356fc237f200f6a3b223f8a2a0137afd487c02
MD5 d906298ea03295da2047a18e9f6940aa
BLAKE2b-256 109387a206b161dcadd21dd20e634c8223198a14f01ae7280ef449bfda8a7dfa

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