Metadata-Version: 2.4
Name: entirius-django-regional
Version: 2.0.0
Summary: Regional reference data for Volkanos services - Country, Currency and Language models with admin API
Project-URL: Repository, https://github.com/entirius/entirius-django-regional
Author: Entirius
License-Expression: MPL-2.0
License-File: LICENSE
Requires-Python: >=3.11
Requires-Dist: django>=4.2
Requires-Dist: djangorestframework-simplejwt>=5.3
Requires-Dist: djangorestframework>=3.14
Requires-Dist: drf-spectacular>=0.27
Requires-Dist: pydantic>=2.0
Requires-Dist: pyyaml>=6.0
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-regional

Regional reference data for Volkanos services — `Country`, `Currency` and `Language` models with seed data
(countries with dialling prefixes, currency symbols, default currencies), a YAML fixture and a read-only
admin API (`/api/regional/v2/admin/`).

## Installation

```shell
pip install entirius-django-regional
```

Add the app to your project and run migrations:

```python
INSTALLED_APPS = [
    ...
    "django_regional",
]
```

```shell
python manage.py migrate
python manage.py loaddata regional-defaults   # optional: EU defaults fixture
```

Mount the admin API:

```python
urlpatterns = [
    ...
    path("", include("django_regional.urls")),
]
```

## Development

```shell
make install     # sync dependencies (uv)
make check       # lint + format check (ruff)
make test        # test suite (pytest + pytest-django, sqlite in-memory)
```

Development and agent instructions: [AGENTS.md](AGENTS.md).

## License

Mozilla Public License 2.0 — see [LICENSE](LICENSE).
