Metadata-Version: 2.4
Name: entirius-django-regon-api
Version: 3.0.0
Summary: REGON/GUS lookup Django module for Volkanos — NIP/REGON search against Polish government registries
Project-URL: Repository, https://github.com/entirius/entirius-django-regon-api
Author: Entirius
Maintainer-email: Piotr Brzozowski <piotrb@entirius.com>, Paweł Kiełt <cptshooter12@gmail.com>, Mateusz Baran <mateuszbaranpv@gmail.com>, Michał Kloczkowski <michal@kloczkowski.pl>
License-Expression: MPL-2.0
License-File: LICENSE
Requires-Python: >=3.11
Requires-Dist: django>=4.0.0
Requires-Dist: entirius-django-utils>=2.0.0
Requires-Dist: entirius-py-bievents>=2.0.0
Requires-Dist: entirius-py-gov-rejestr-wl-sdk>=2.0.0
Requires-Dist: entirius-py-process-logger>=2.0.0
Requires-Dist: marshmallow-dataclass>=8.5.3
Requires-Dist: marshmallow<4,>=3.15
Requires-Dist: zeep>=4.3.2
Provides-Extra: dev
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-django; extra == 'test'
Description-Content-Type: text/markdown

# Django Regon API

REGON/GUS lookup Django module for Volkanos — a thin layer between other Django apps and Polish
government registries: REGON/BIR (`api.stat.gov.pl`, SOAP via `zeep`) and the VAT taxpayers
registry (`wl-api.mf.gov.pl` via `entirius-py-gov-rejestr-wl-sdk`).

## Install

```bash
uv pip install entirius-django-regon-api
```

Add `django_regon_api` to `INSTALLED_APPS`.
Endpoints mount under `{API_BASE_URL}/regon/<version>/` (`nip/<nip>/`, `regon/<regon>/`).

Settings (all optional, sandbox defaults): `BIR_API_KEY`, `BIR_SERVICE_URL`, `BIR_WSDL_URL`,
`BIR_VERSIONS`, `GOV_REJESTR_WL_USE_PROD_ENVIRONMENT`, cache prefixes/timeouts —
reference in [AGENTS.md](AGENTS.md), BIR details in [docs/](docs/README.md).

## Development and testing

```bash
make install   # uv sync, incl. extras
make check     # ruff lint + format-check
make test      # pytest
```
