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

Uploaded Source

Built Distribution

politico_civic_utils-0.0.6-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

Details for the file politico-civic-utils-0.0.6.tar.gz.

File metadata

  • Download URL: politico-civic-utils-0.0.6.tar.gz
  • Upload date:
  • Size: 19.2 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-0.0.6.tar.gz
Algorithm Hash digest
SHA256 6840e318d0a960dd73ae22a9bdccd81f6f13e8f21b6f94f7fed157b588caa2a9
MD5 b889d67726e8ac092256e8d67aeef10c
BLAKE2b-256 9077ff8d007320520c1a07f2549fb936999bee89aff67c62f5453a8eeb0965f4

See more details on using hashes here.

File details

Details for the file politico_civic_utils-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: politico_civic_utils-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 24.2 kB
  • Tags: Python 3
  • 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-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e4bc0cca35c55389fa01b674774457aca463f6240192efe3a66c36b1ac47cda3
MD5 cbf8271439552b4a9d5e932506dcbb20
BLAKE2b-256 409e152ca987a694a14c74092857531edafc2b79484676e4ed4398b764d61b3d

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