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

Uploaded Source

Built Distribution

politico_civic_utils-1.0a1.dev1-py2-none-any.whl (24.4 kB view details)

Uploaded Python 2

File details

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

File metadata

  • Download URL: politico-civic-utils-1.0a1.dev1.tar.gz
  • Upload date:
  • Size: 18.5 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.dev1.tar.gz
Algorithm Hash digest
SHA256 cf25e48fa9ffd43cbe51e4fe52bf141690bffc24ad57db9532f31d96f707370c
MD5 079a841ef9826d914fabbddd3ed326aa
BLAKE2b-256 f89a357b95ca63aeb06027ddb9563c81431047392289e6a8af5929539aa32443

See more details on using hashes here.

File details

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

File metadata

  • Download URL: politico_civic_utils-1.0a1.dev1-py2-none-any.whl
  • Upload date:
  • Size: 24.4 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.dev1-py2-none-any.whl
Algorithm Hash digest
SHA256 161848f03396e29e4ad13b0b3de82476547e7593a38bc2a01941592a43161b26
MD5 584ff7db8421fe756d1b838a0a4321fa
BLAKE2b-256 db694427cdb0851a4e294ccf59f5aee8d39156f14683a83711b569ac553ff874

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