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

Uploaded Source

Built Distribution

politico_civic_utils-1.0a1.dev9-py2-none-any.whl (25.2 kB view details)

Uploaded Python 2

File details

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

File metadata

  • Download URL: politico-civic-utils-1.0a1.dev9.tar.gz
  • Upload date:
  • Size: 19.1 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.dev9.tar.gz
Algorithm Hash digest
SHA256 d23825979e716fb07ed013341f405c20d385001c8812573b8e04679791a3323e
MD5 ef628cb10685581a04a58e3405faaeca
BLAKE2b-256 89d5e99a1ed52ca2eb0775ba9aa476f4df96e112628eb134226462d54a7b28c0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: politico_civic_utils-1.0a1.dev9-py2-none-any.whl
  • Upload date:
  • Size: 25.2 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.dev9-py2-none-any.whl
Algorithm Hash digest
SHA256 0f2caac9513dc868ac4229ef6bcf867f6be837db2c5033cde253fdb52a189cf1
MD5 ef163a5d18f1815965a19f429b0dd6bb
BLAKE2b-256 2af179a54dc4881660dee37c78b2a1be637b463170756819b1fba014accf3631

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