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

Uploaded Source

Built Distribution

politico_civic_utils-0.0.2-py2-none-any.whl (24.0 kB view details)

Uploaded Python 2

File details

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

File metadata

  • Download URL: politico-civic-utils-0.0.2.tar.gz
  • Upload date:
  • Size: 18.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.2.tar.gz
Algorithm Hash digest
SHA256 b3c9d67d066f7921cb4c0abbb290f04f1b6ad50f687e708dcc2f22b76a1fca17
MD5 c6344a3fd9bd3bce329bbfed912bdf8a
BLAKE2b-256 40251e135b2e8ad35d6945acb228956e71ed9e2f2e9c71467e58a643d3d55561

See more details on using hashes here.

File details

Details for the file politico_civic_utils-0.0.2-py2-none-any.whl.

File metadata

  • Download URL: politico_civic_utils-0.0.2-py2-none-any.whl
  • Upload date:
  • Size: 24.0 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-0.0.2-py2-none-any.whl
Algorithm Hash digest
SHA256 4fcaa68c4d83764d68b29b40a5abea8046e6d109c50eb371b6a5488cb6244258
MD5 5b75ad31f74da8d76ff0a5f5f8680c59
BLAKE2b-256 54305abe7b7b174e63df77166b1ac1ee561d70912cf56ab39fdfde2c9f550e3f

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