Metadata-Version: 2.1
Name: politico-civic-entity
Version: 1.0a1.dev2
Summary: Manage political people and organizations, the POLITICO way.
Home-page: https://github.com/The-Politico/politico-civic-entity/
Author: POLITICO interactive news
Author-email: interactives@politico.com
License: MIT
Download-URL: https://github.com/The-Politico/politico-civic-entity/archive/1.0a1.dev2.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: pycountry
Requires-Dist: us
Requires-Dist: django
Requires-Dist: django-uuslug
Requires-Dist: djangorestframework
Requires-Dist: django-storages
Requires-Dist: boto3
Requires-Dist: Pillow
Requires-Dist: psycopg2-binary
Requires-Dist: politico-civic-utils
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'

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

# django-politico-civic-entity

Manage political people and organizations, the POLITICO way.

### Quickstart

1. Install the app.

  ```
  $ pip install politico-civic-entity
  ```

2. Add the app to your Django project settings.

  ```python
  INSTALLED_APPS = [
      # ...
      'rest_framework',
      'entity',
  ]
  ```

3. Migrate the database

  ```
  $ python manage.py migrate entity
  ```


### Developing

##### Running a development server

Move into the example directory, install dependencies and run the development server with pipenv.

  ```
  $ cd example
  $ pipenv install
  $ pipenv run python manage.py runserver
  ```

##### Setting up a PostgreSQL database

1. Run the make command to setup a fresh database.

  ```
  $ make database
  ```

2. Add a connection URL to `example/.env`.

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

3. Run migrations from the example app.

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


