Updated docs, requirements, bumped version number

Author: scibi

HISTORY.rst

@@ -7,3 +7,12 @@ History
 ++++++++++++++++++
 
 * First release on PyPI.
+
+0.2.0 (2015-01-08)
+++++++++++++++++++
+
+* Added support for Django 1.7 migrations
+* Moved common data to abstract base class
+* Added common flag filed (aktywny)
+* Added 3 model managers to JednostkaAdministracyjna
+* Fixed PEP 8 compliance in main source files

Makefile

@@ -0,0 +1,57 @@
+.PHONY: clean-pyc clean-build docs clean
+
+help:
+	@echo "clean-build - remove build artifacts"
+	@echo "clean-pyc - remove Python file artifacts"
+	@echo "lint - check style with flake8"
+	@echo "test - run tests quickly with the default Python"
+	@echo "test-all - run tests on every Python version with tox"
+	@echo "coverage - check code coverage quickly with the default Python"
+	@echo "docs - generate Sphinx HTML documentation, including API docs"
+	@echo "release - package and upload a release"
+	@echo "sdist - package"
+
+clean: clean-build clean-pyc
+	rm -fr htmlcov/
+
+clean-build:
+	rm -fr build/
+	rm -fr dist/
+	rm -fr *.egg-info
+
+clean-pyc:
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+
+lint:
+	flake8 --exclude=migrations,south_migrations teryt tests
+
+test:
+	python setup.py test
+
+test-all:
+	tox
+
+coverage:
+	coverage run --source teryt setup.py test
+	coverage report -m
+	coverage html
+	open htmlcov/index.html
+
+#docs:
+#	rm -f docs/python-waze.rst
+#	rm -f docs/modules.rst
+#	sphinx-apidoc -o docs/ waze
+#	$(MAKE) -C docs clean
+#	$(MAKE) -C docs html
+#	open docs/_build/html/index.html
+
+release: clean
+	python setup.py sdist upload
+	python setup.py bdist_wheel upload
+
+dist: clean
+	python setup.py sdist
+	python setup.py bdist_wheel
+	ls -l dist

README.rst

@@ -18,12 +18,12 @@ 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
+* identifiers and names of units of territorial division,
+* identifiers and names of localities,
+* identifiers and names of streets
 
-This app allows to parse XML files from GUS and import them to database. It is
-meant to be used as a part of a larger system.
+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
 -------------
@@ -37,20 +37,32 @@ Install django-teryt::
 
     pip install django-teryt
 
-Add ``teryt`` to ``INSTALLED_APPS`` in your ``settings.py`` and run::
+If you are using Django 1.6 or lower you have to install South::
 
-    ./manage.py syncdb
+    pip install 'south>=1.0'
 
-or::
+Add ``teryt`` to ``INSTALLED_APPS`` in your ``settings.py`` and run::
 
     ./manage.py migrate teryt
 
-if you use ``south``. Then download TERYT data from
-`GUS website <http://www.stat.gov.pl/broker/access/prefile/listPreFiles.jspa>`_, unpack it and then import it::
+Then download TERYT data from
+`GUS website <http://www.stat.gov.pl/broker/access/prefile/listPreFiles.jspa>`_,
+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
 --------
 
-* TODO
+* 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 ;)
+

requirements-test.txt

@@ -1,7 +1,13 @@
-django>=1.5.1
+-r requirements.txt
+flake8
 coverage
-mock>=1.0.1
-nose>=1.3.0
-django-nose>=1.2
 
-# Additional test requirements go here
+
+#mock>=1.0.1
+#nose>=1.3.0
+#django-nose>=1.2
+#
+#httpretty
+#sure>=1.2.5
+#coveralls
+

requirements.txt

@@ -1,3 +1,6 @@
 django>=1.5.1
 
-# Additional requirements go here
+# Only if you are using Django<1.7
+#South>=1.0
+
+# Additional requirements go here

setup.py

@@ -1,5 +1,5 @@
-# -*- coding: utf-8 -*-
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 
 import os
 import sys
@@ -34,6 +34,7 @@
     packages=[
         'teryt',
     ],
+    package_dir={'teryt': 'teryt'},
     include_package_data=True,
     install_requires=[
     ],
@@ -52,4 +53,5 @@
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.3',
     ],
+    test_suite='tests',
 )

teryt/__init__.py

@@ -1 +1 @@
-__version__ = '0.1.0'
+__version__ = '0.2.0'