Metadata-Version: 1.1
Name: ares-util
Version: 0.1.0
Summary: 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).
Home-page: https://github.com/illagrenan/ares_util
Author: Vašek Dohnal
Author-email: vaclav.dohnal@gmail.com
License: MIT
Description: Ares\_util
        ==========
        
        |Travis CI Badge|   |Coverage Status|   |PyPI version|
        
        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
        ---------
        
        .. code:: shell
        
            pip install ares-util
        
        Použití
        -------
        
            Testováno v Python ``2.7.*``.
        
        .. code:: shell
        
            $ python
            >>> from ares_util.ares import call_ares
            >>> call_ares(42)
            False
            >>> call_ares(27074358)
            {'legal': {'company_name': u'Asseco Central Europe, a.s.', 'company_id': 27074358}, 'address': {'city': u'Praha', 'region': u'Hlavn\xed m\u011bsto Praha', 'street':
            u'Bud\u011bjovick\xe1 778/3a', 'city_part': u'Michle'}}
        
        Django podpora
        ~~~~~~~~~~~~~~
        
            Testováno pro Django ve verzi ``1.5`` a nejnovější ``1.6``.
        
        K dispozi jsou dva `Django
        validátory <https://docs.djangoproject.com/en/1.6/ref/validators/>`__
        formulářových polí:
        
        -  ``czech_company_id_numeric_validator`` - Ověřuje, zda IČ splňuje
           statické parametry, tj. 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])
        
        TODOs
        =====
        
        -  [X] Dokončit podporu pro Django (validátory formulářových polí).
        -  [X] Travis CI, Coveralls
        -  [ ] Crate.io
        -  [X] Opravit homepage na pypi
        -  [ ] Ověřit a případně vyřešit kompatibilitu s Python 3.
        -  [ ] Zvážit podporu pro načítání dat i z Justice.cz
           (http://www.tomas-dvorak.cz/clanky/nacitani-dat-z-obchodniho-rejstriku-justicecz)
        
        Reference
        =========
        
        1. http://www.abclinuxu.cz/blog/bloK/2008/10/kontrola-ic,
           http://latrine.dgx.cz/jak-overit-platne-ic-a-rodne-cislo
        
        Technické informace
        ===================
        
        XML response z ARESu je zpracována pomocí
        `xmltodict <https://github.com/martinblech/xmltodict>`__.
        
        Licence
        =======
        
        The MIT License (MIT)
        
        Copyright (c) 2013 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.
        
        .. |Travis CI Badge| image:: https://api.travis-ci.org/illagrenan/ares_util.png
           :target: https://travis-ci.org/illagrenan/ares_util
        .. |Coverage Status| image:: https://coveralls.io/repos/illagrenan/ares_util/badge.png
           :target: https://coveralls.io/r/illagrenan/ares_util
        .. |PyPI version| image:: https://badge.fury.io/py/ares_util.png
           :target: http://badge.fury.io/py/ares_util
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
