Prefer format() over % for string interpolation

README.md

@@ -115,8 +115,8 @@ Testy spustíte pomocí `tox` anebo `fab test` máte-li Fabric.
 
 Využít můžete i přibalený Flask server pro lokální testování. Stačí spustit:
 
-```
-$ python .\server.py
+```shell
+python .\server.py
  * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
  * Restarting with stat
 ```

README.rst

@@ -0,0 +1,186 @@
+Ares\_util
+==========
+
+|PyPI version|   |License|   |Requirements Status|
+
+|Travis CI Badge|   |Build status|   |Coverage Status| |Code Issues|
+
+Představení
+-----------
+
+Jednoduchý nástroj pro validaci1 českého IČ. U předaného čísla je
+nejdříve ověřen jeho kontrolní součet (viz
+`Reference <https://github.com/illagrenan/ares_util/master/README.md#reference>`__)
+a dle výsledku se následně zasílá požadavek na `ARES XML
+API <http://wwwinfo.mfcr.cz/ares/ares_xml.html.cz>`__.
+
+Pokud je IČ validní, vrací nástroj ``dict`` se základními údaji o firmě
+(obchodní název, adresa).
+
+    Doporučuji prostudovat `Podmínky provozu ARES
+    API <http://wwwinfo.mfcr.cz/ares/ares_podminky.html.cz>`__, zejména
+    pak:
+
+    Ministerstvo financí vyhrazuje právo omezit nebo znemožnit přístup k
+    www aplikaci ARES uživatelům, kteří: \* odešlou k vyřízení více než
+    1000 dotazů v době od 8:00 hod. do 18:00 hod., \* odešlou k vyřízení
+    více než 5000 dotazů v době od 18:00 hod. do 8:00 hod. rána
+    následujícího dne, \* opakovaně posílají nesprávně vyplněné dotazy,
+    \* opakovaně posílají stejné dotazy, \* mají větší počet současně
+    zadaných dotazů (pro automatizované XML dotazy), \* obcházejí
+    povolené limity využíváním dotazování z většího množství IP adres,
+    \* automatizovaně propátrávají databázi náhodnými údaji nebo
+    generují většinu nesprávných dotazů.
+
+Instalace
+---------
+
+**A)** Stabilní verze (doporučeno)
+
+.. code:: shell
+
+    pip install --upgrade ares-util
+
+**B)** Vývojová verze
+
+.. code:: shell
+
+    pip install --upgrade git+git://github.com/illagrenan/ares_util.git
+
+Použití
+-------
+
+    Doplněk podporuje Python ``2.7``, ``3.3`` a ``3.4``. TravisCI
+    testuje i oproti ``pypy``.
+
+.. code:: shell
+
+    python
+    >>> from ares_util.ares import call_ares
+    >>> call_ares(42)
+    False
+    >>> call_ares('68407700')
+    {
+        u'legal': {
+            u'company_vat_id': u'CZ68407700',
+            u'company_name': u'České vysoké učení technické v Praze',
+            u'legal_form': u'601',
+            u'company_id': u'68407700'
+        },
+        u'address': {
+            u'city': u'Praha',
+            u'region': u'Hlavní město Praha',
+            u'street': u'Zikova 1903/4',
+            u'city_part': u'Dejvice',
+            u'zip_code': u'16000'
+        }
+    }
+
+Django podpora
+~~~~~~~~~~~~~~
+
+    Testováno pro Django ``>=1.5.*,<1.9.*``.
+
+K dispozi jsou dva `Django
+validátory <https://docs.djangoproject.com/en/dev/ref/validators/>`__
+formulářových polí:
+
+-  ``czech_company_id_numeric_validator`` - Ověřuje, zda IČ splňuje
+   statické parametry, tj. 7 nebo 8 číslic a kontrolní součet.
+-  ``czech_company_id_ares_api_validator`` - Platnost IČ ověřuje pomocí
+   ARES API. Tento validátor před ARES požadavkem rovněž ověřuje
+   statické parametry, proto by **neměly být použity oba validátory
+   zároveň**.
+
+.. code:: python
+
+    # settings.py
+    INSTALLED_APPS = (
+        # ...
+        'ares_util',
+    )
+
+.. code:: python
+
+    from ares_util.validators import czech_company_id_numeric_validator, czech_company_id_ares_api_validator
+    from django import forms
+
+    # forms.py
+    class DemoForm(forms.Form):
+        company_id = forms.IntegerField(required=True, validators=[czech_company_id_ares_api_validator])
+
+Reference
+=========
+
+1. http://www.abclinuxu.cz/blog/bloK/2008/10/kontrola-ic,
+   http://latrine.dgx.cz/jak-overit-platne-ic-a-rodne-cislo
+
+Lokální vývoj
+=============
+
+Chcete-li upravit doplněk lokálně, jednoduše stáhněte zdrojové kódy a
+nainstalujte závislosti:
+
+.. code:: shell
+
+    pip install -r requirements.txt --upgrade
+
+Testy spustíte pomocí ``tox`` anebo ``fab test`` máte-li Fabric.
+
+Využít můžete i přibalený Flask server pro lokální testování. Stačí
+spustit:
+
+.. code:: shell
+
+    python .\server.py
+     * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
+     * Restarting with stat
+
+a v prohlížeči otevřít např.: ``http://127.0.0.1:5000/42``.
+
+Technické informace
+===================
+
+XML response z ARESu je zpracována pomocí
+`xmltodict <https://github.com/martinblech/xmltodict>`__.
+
+Licence
+=======
+
+The MIT License (MIT)
+
+Copyright (c) 2013–2015 Vašek Dohnal
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+.. |PyPI version| image:: https://badge.fury.io/py/ares_util.png
+   :target: http://badge.fury.io/py/ares_util
+.. |License| image:: https://img.shields.io/badge/license-MIT-blue.svg
+   :target: https://pypi.python.org/pypi/ares_util/
+.. |Requirements Status| image:: https://requires.io/github/illagrenan/ares_util/requirements.svg?branch=master
+   :target: https://requires.io/github/illagrenan/ares_util/requirements/?branch=master
+.. |Travis CI Badge| image:: https://api.travis-ci.org/illagrenan/ares_util.png
+   :target: https://travis-ci.org/illagrenan/ares_util
+.. |Build status| image:: https://ci.appveyor.com/api/projects/status/8ui732iutoe9r0vj?svg=true
+   :target: https://ci.appveyor.com/project/illagrenan/ares-util
+.. |Coverage Status| image:: https://coveralls.io/repos/illagrenan/ares_util/badge.png
+   :target: https://coveralls.io/r/illagrenan/ares_util
+.. |Code Issues| image:: http://www.quantifiedcode.com/api/v1/project/81deabb48fbd45cfb9b4d83f0a8d2cca/badge.svg
+   :target: http://www.quantifiedcode.com/app/project/81deabb48fbd45cfb9b4d83f0a8d2cca

ares_util/ares.py

@@ -116,7 +116,7 @@ def get_czech_zip_code(ares_data, full_text_address):
     if search:
         return search.groupdict()["zip_code"].strip()
     else:
-        logging.warning("Cannot retrieve ZIP_CODE from this: \"%s\" address" % full_text_address)
+        logging.warning("Cannot retrieve ZIP_CODE from this: \"{0}\" address".format(full_text_address))
 
         # TODO Improve this code
         return ""

setup.py

@@ -20,7 +20,7 @@ def read_md(file_name):
 # https://hynek.me/articles/sharing-your-labor-of-love-pypi-quick-and-dirty/
 setup(
     name='ares_util',
-    version='0.1.8',
+    version='0.1.9',
     description='A tool for information system allowing a retrieval '
                 'of information on economic entities registered in '
                 'the Czech Republic (ARES - Access to Registers of Economic Subjects / Entities).',