-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
16 changed files
with
11 additions
and
21,172 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,4 @@ | ||
include LICENSE | ||
include README.rst | ||
recursive-include councilmatic_core/static * | ||
recursive-include councilmatic_core/templates * | ||
recursive-include councilmatic_core/migrations * | ||
recursive-include councilmatic_core/management * | ||
recursive-include councilmatic_core/templatetags * | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,7 @@ | ||
django-councilmatic | ||
=================== | ||
|
||
The django-councilmatic app provides the core functionality for the `Councilmatic family <http://www.councilmatic.org/>`_, a set of web apps for keeping tabs on local city council. It is built upon the Open Civic Data standard and ultimately makes Councilmatic easier to re-deploy in new cities. | ||
|
||
|
||
Requirements | ||
------------ | ||
- Python >= 3.6 | ||
|
||
Features | ||
-------- | ||
|
||
- Models for bills, people, organizations, events, and more | ||
- Base views for Bill, Person, Organization, and Event listing and detail pages | ||
- Search infrastructure powered by :code:`django-haystack` and Solr | ||
|
||
The `Councilmatic family <http://www.councilmatic.org/>`_ includes: | ||
|
||
- Philly Councilmatic (the original and first Councilmatic, by Mjumbe Poe, an important predecessor to DataMade's django-councilmatic) | ||
- `Chicago Councilmatic <https://github.com/datamade/chi-councilmatic>`_ | ||
- `Los Angeles Metro Board <https://github.com/datamade/la-metro-councilmatic>`_ | ||
|
||
|
||
Councilmatic in your city | ||
------------------------- | ||
If you're interested in bringing Councilmatic to your city, `contact us <mailto:[email protected]>`_! We'd love to help. | ||
|
||
Want to build your own Councilmatic? Check out our `Starter Template <https://github.com/datamade/councilmatic-starter-template>`_. It contains everything you need to create your own Councilmatic from scratch. | ||
|
||
The django-councilmatic app provides the core models for the `Councilmatic family <http://www.councilmatic.org/>`_, a set of web apps for keeping tabs on local city council. | ||
|
||
Extending Open Civic Data/Councilmatic models | ||
--------------------------------------------- | ||
|
@@ -51,51 +25,6 @@ django-councilmatic makes extensive use of proxy models to add custom managers a | |
If you wish to customize the class of related objects, first proxy an OCD model, then override one or more of its related object attributes with an instance of `ProxyForeignKey`. See `councilmatic_core.models.BillAction <https://github.com/datamade/django-councilmatic/blob/449ff74d3968b0f34016698d4ee89ff50a7b33ef/councilmatic_core/models.py#L612>`_ for an example. | ||
|
||
|
||
Running tests | ||
------------- | ||
|
||
Did you make changes to django-councilmatic? Before you make a pull request, run some tests. | ||
|
||
First, install the test requirements: | ||
|
||
.. code-block:: bash | ||
pip install -r tests/requirements.txt | ||
We test for functionality with `pytest`: | ||
|
||
.. code-block:: bash | ||
pytest | ||
If you made material changes to the Councilmatic models, refresh the test fixture from a local instance database. From your instance directory (assuming you've already installed :code:`django-councilmatic` with :code:`pip install -e /path/to/django-councilmatic`), install the test requirements: | ||
|
||
.. code-block:: bash | ||
pip install -r /path/to/django-councilmatic/tests/test_requirements.txt | ||
Add :code:`fixture_magic` to your instance's :code:`INSTALLED_APPS` in :code:`settings.py`. | ||
|
||
Run the management command to update the test fixture. | ||
|
||
.. code-block:: bash | ||
python manage.py make_fixtures | ||
Run the tests and commit your updated fixture with your PR! | ||
|
||
|
||
Patches and Contributions | ||
------------------------- | ||
We continue to improve django-councilmatic, and we welcome your ideas! You can make suggestions in the form of `github issues <https://github.com/datamade/django-councilmatic/issues>`_ (bug reports, feature requests, general questions), or you can submit a code contribution via a pull request. | ||
|
||
How to contribute code: | ||
|
||
- Fork the project. | ||
- Make your feature addition or bug fix. | ||
- Send us a pull request with a description of your work! Don't worry if it isn't perfect - think of a PR as a start of a conversation, rather than a finished product. | ||
|
||
|
||
Copyright | ||
--------- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,35 +4,24 @@ | |
with open(os.path.join(os.path.dirname(__file__), "README.rst")) as readme: | ||
README = readme.read() | ||
|
||
# allow setup.py to be run from any path | ||
os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir))) | ||
|
||
setup( | ||
name="django-councilmatic", | ||
python_requires=">=3.6", | ||
version="3.2", | ||
packages=find_packages(exclude=("tests",)), | ||
version="4.0", | ||
packages=find_packages(), | ||
include_package_data=True, | ||
license="MIT License", # example license | ||
description="Core functions for councilmatic.org family", | ||
license="MIT License", | ||
description="Core models for councilmatic.org family", | ||
long_description=README, | ||
url="http://councilmatic.org/", | ||
author="DataMade, LLC", | ||
author_email="[email protected]", | ||
install_requires=[ | ||
"requests>=2.20", | ||
"opencivicdata>=3.1.0", | ||
"pytz>=2015.4", | ||
"django-haystack>=3.2,<3.3", | ||
"Django>=3.2,<3.3", | ||
"django-proxy-overrides>=0.2.1", | ||
"python-dateutil>=2.7,<2.8", | ||
"psycopg2-binary>=2.9.5", | ||
"django-adv-cache-tag==1.1.2", | ||
"boto==2.38.0", | ||
"tqdm", | ||
], | ||
extras_require={"convert_docs": ["textract"]}, | ||
classifiers=[ | ||
"Environment :: Web Environment", | ||
"Framework :: Django", | ||
|
Empty file.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.