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

Uploaded Source

Built Distribution

File details

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

File metadata

  • Download URL: politico-civic-utils-1.0a2.dev5.tar.gz
  • Upload date:
  • Size: 21.6 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.dev5.tar.gz
Algorithm Hash digest
SHA256 f7b4600e85e02f341649adb334025230b8235b6a0bb4096c80145efeb5509ebe
MD5 443f9920a2183e14a52b12267cb24dd6
BLAKE2b-256 1de385c29eb201d4d94e611f189a25a3cd354f08f6631538bbcc678a9e517275

See more details on using hashes here.

File details

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

File metadata

  • Download URL: politico_civic_utils-1.0a2.dev5-py2-none-any.whl
  • Upload date:
  • Size: 28.7 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.dev5-py2-none-any.whl
Algorithm Hash digest
SHA256 3606449570ce54d95d624d446723ae022e7a5b906d0b64f0e5630a3621db1624
MD5 50776b66e55913069475352c9b16a4e2
BLAKE2b-256 f96201e9cc0cc65eb198a3695782139be6b0c0720d09b86cde79db4774833a38

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