Metadata-Version: 2.1
Name: politico-civic-utils
Version: 1.0a2.dev4
Summary: Shared utilities for POLITICO Civic apps
Home-page: https://github.com/The-Politico/politico-civic-utils/
Author: POLITICO interactive news
Author-email: interactives@politico.com
License: MIT
Download-URL: https://github.com/The-Politico/politico-civic-utils/archive/1.0a2.dev4.tar.gz
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.0
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Description-Content-Type: text/markdown
Requires-Dist: django
Requires-Dist: django-uuslug
Requires-Dist: djangorestframework
Requires-Dist: boto3
Requires-Dist: crayons
Requires-Dist: psycopg2-binary
Requires-Dist: progress
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'

![POLITICO](https://rawgithub.com/The-Politico/src/master/images/logo/badge.png)

# politico-civic-utils

### Quickstart

1. Install the app.

  ```
  $ pip install politico-civic-utils
  ```

2. Add the app to your Django project and configure settings.

  ```python
  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
  ```

2. Add a connection URL to the `.env` file.

  ```
  DATABASE_URL="postgres://localhost:5432/civic_utils"
  ```

3. Run migrations from the example app.

  ```
  $ cd example
  $ pipenv run python manage.py migrate
  ```


