Welcome to django-teryt’s documentation!¶
Contents:
django-teryt¶
django-teryt is a Django app that implements TERYT database. TERYT (Polish: “Krajowy Rejestr Urzędowy Podziału Terytorialnego Kraju”, English: “National Official Register of Territorial Division of the Country”) is a register maintained by Polish Central Statistical Office (Polish: Główny Urząd Statystyczny; GUS). Among other things it contains:
- identifiers and names of units of territorial division,
- identifiers and names of localities,
- identifiers and names of streets
This app parses XML files from GUS and it imports them to the database. It is meant to be used as a part of a larger system.
Documentation¶
The full documentation is at https://django-teryt.readthedocs.org.
Quickstart¶
Install django-teryt:
pip install django-teryt
If you are using Django 1.6 or lower you have to install South:
pip install 'south>=1.0'
Add teryt to INSTALLED_APPS in your settings.py and run:
./manage.py migrate teryt
Then download TERYT data from GUS website, unpack it and then import it:
./manage.py teryt_parse /path/to/WMRODZ.xml /path/to/TERC.xml /path/to/SIMC.xml /path/to/ULIC.xml
Features¶
- It can import all data from all TERYT files
- It deals with updates (just run ./manage.py teryt_parse –update TERC.xml)
- It keeps flag (aktywny) telling you if some record is still present in TERYT (there are some minor changes in territorial division from time to time)
Support¶
All bug reports and pull requests are welcome. You can report them at https://github.com/scibi/django-teryt/issues. It can be in English or in Polish ;)
Installation¶
At the command line:
$ easy_install django-teryt
Or, if you have virtualenvwrapper installed:
$ mkvirtualenv django-teryt
$ pip install django-teryt
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/scibi/django-teryt/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
Write Documentation¶
django-teryt could always use more documentation, whether as part of the official django-teryt docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/scibi/django-teryt/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up django-teryt for local development.
Fork the django-teryt repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/django-teryt.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv django-teryt $ cd django-teryt/ $ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 teryt tests
$ python setup.py test
$ tox
To get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
- The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/scibi/django-teryt/pull_requests and make sure that the tests pass for all supported Python versions.