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

Uploaded Source

Built Distribution

politico_civic_utils-0.0.4-py2-none-any.whl (24.1 kB view details)

Uploaded Python 2

File details

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

File metadata

  • Download URL: politico-civic-utils-0.0.4.tar.gz
  • Upload date:
  • Size: 18.3 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.4.tar.gz
Algorithm Hash digest
SHA256 3060f3fb6c5bcbffd8c5216f5ab9aed14ad42b4b65fb867e13aafaefec9b60b2
MD5 e991dbe027a3b9470725d31ca3cae798
BLAKE2b-256 30554d9aa07e7db9023af71ade319d9c07e3172606dcfb6a0cd42e255c8f3909

See more details on using hashes here.

File details

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

File metadata

  • Download URL: politico_civic_utils-0.0.4-py2-none-any.whl
  • Upload date:
  • Size: 24.1 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.4-py2-none-any.whl
Algorithm Hash digest
SHA256 2bd72c848ef327bbebbd7d25b0f839af201fee9cd47119ad4effb4e26a129888
MD5 0ce62a7989ea3c53e6586aed7792696c
BLAKE2b-256 83cd1c4c48c89c53556dc5dc035c81306be0b0ee9ed3cf4040441a0dd000bd34

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