Metadata-Version: 2.1
Name: django-popolo
Version: 2.4.0
Summary: A Django-based model of the OpenGovernment context, compliant with the Popolo data specifications.
Home-page: http://github.com/openpolis/django-popolo
Author: Guglielmo Celata
Author-email: guglielmo@openpolis.it
License: Affero
Platform: UNKNOWN
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Framework :: Django
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Requires-Dist: django-autoslug
Requires-Dist: django-model-utils

popolo
========================


.. image:: https://travis-ci.org/openpolis/django-popolo.svg?branch=master
  :target: https://travis-ci.org/openpolis/django-popolo

.. image:: https://coveralls.io/repos/github/openpolis/django-popolo/badge.svg?branch=master
  :target: https://coveralls.io/github/openpolis/django-popolo?branch=master


Welcome to the documentation for django-popolo!


**django-popolo** is a django-based implementation of the
`Popolo's open government data specifications <http://popoloproject.com/>`_.

It is developed as a django application to be deployed directly within django projects.

It will allow web developers using it to manage and store data according to Popolo's specifications.

The standard sql-oriented django ORM will be used.

From release 1.2.0, django-popolo includes classes that extend the model, although compatibility
with the standard is kept.

Release 2.0.0 introduces a change in how Sources and Links are referred to,
that breaks compatibility with the popit importer.

See the CHANGELOG.md file for more details.


Installation
------------
To install ``django-popolo`` as a third party app within a django project,
you need to add it to the django project's requirements.txt.
You can do this from GitHub in the usual way, or using the
``django-popolo`` package on PyPI.


Compatibility
-------------


Running the Tests
-----------------

Set up the test environment with::

    pip install -r tests_requirements.txt
    python setup.py install

You can run the tests with::

    python setup.py test

or::

    python runtests.py

Notes on mysociety's fork
-------------------------
`mysociety/django-popolo <https://github.com/mysociety/django-popolo>`_ is a fork of this project where integer IDs are used
instead of slugs.

Our packages, since version 1.1 also uses numerical ids as primary keys for all entities.
Slugs are available as non-primary fields, for the 4 main classes (``Person``, ``Organization``, ``Post``, ``Membership``).
Slugs are used through the ``Permalinkable`` behavior, that adds the ``slug`` field to the class, populating it according to rules defined in each class.




