Ares_util

Latest release
CI
Dependencies

Představení

Jednoduchý nástroj pro validaci¹ českého IČ. U předaného IČ je nejdříve ověřen jeho kontrolní součet (viz Reference) a dle výsledku se následně zasílá požadavek na ARES XML API.

Pokud je IČ validní, vrací nástroj dict se základními údaji o firmě (obchodní název, adresa).

Podmínky provozu ARES API

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ů.

—Zdroj: Podmínky provozu ARES API.

Instalace

Podporované verze Pythonu jsou pypy, pypy3, 2.7, 3.5, 3.6 a 3.7.

pip install --upgrade ares-util

Použití

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

Podporované verze Djanga jsou 1.11.x (LTS), 2.0.x a 2.1.x.

K dispozi jsou dva Django validátory 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ň.

Použití ve formuláři

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

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:

pip install -r requirements.txt --upgrade

Testy spustíte pomocí tox nebo inv test. Využít můžete i přibalený Flask server pro lokální testování. Stačí spustit:

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.

Licence

The MIT License (MIT)

Metadata

Release files for ares-util 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ares-util 0.3.0
File	Size	Uploaded	Provenance
ares_util-0.3.0.tar.gz	9.6 kB	Jan 9, 2024	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for ares-util 0.3.0
File	Interpreter	ABI	Platform	Reset
ares_util-0.3.0-py2.py3-none-any.whl 8.8 kB Jan 9, 2024 Without provenance	Python 2, Python 3	none	any	Details

Total release size: 18.3 kB

Release files / ares_util-0.3.0.tar.gz

Download URL	ares_util-0.3.0.tar.gz
Size	9.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`e90bf69b678f94502c1353ba37b19e66a8bfa5442e01704c9b225a4c48d6d885`
BLAKE2b-256 checksum How to use checksums	`27cd8f9f1fa0d38fabd5988af82fb94698cc9a8f321e8c45c342cadfe04f1b84`
Upload date	Jan 9, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.3.dev62+gfe1885f CPython/3.11.6`

Release files / ares_util-0.3.0-py2.py3-none-any.whl

Download URL	ares_util-0.3.0-py2.py3-none-any.whl
Size	8.8 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`1149c654981161694496dc61fd7b738f61f390577a467bbe7dc8aa74fe2a3967`
BLAKE2b-256 checksum How to use checksums	`020c1294f63f96ae23ed3e1fcb990e1d02c850095e9a4a2b6baece1e0a399ab4`
Upload date	Jan 9, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.3.dev62+gfe1885f CPython/3.11.6`

Security for ares-util 0.3.0

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.