Metadata-Version: 2.4
Name: entirius-django-baselinker
Version: 2.0.1
Summary: Baselinker Django module for Volkanos
Project-URL: Repository, https://github.com/entirius/entirius-django-baselinker
Author: Entirius
License-Expression: MPL-2.0
License-File: LICENSE
Requires-Python: >=3.11
Requires-Dist: django>=4.0.0
Requires-Dist: entirius-py-int-enum-choices>=2.0.0
Requires-Dist: marshmallow-dataclass
Requires-Dist: requests
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-baselinker

Baselinker integration module for Volkanos — stores Baselinker accounts, mirrors order statuses,
order sources and journal events, and wraps the [Baselinker API](https://api.baselinker.com/)
with a rate-limit-aware client.

## Installation

```shell
pip install entirius-django-baselinker
```

Add the app to your project:

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

## Usage

```python
from django_baselinker.models import BaselinkerAccount
from django_baselinker.utils import BaselinkerClient

client = BaselinkerClient.from_account(BaselinkerAccount.objects.get(email="shop@example.com"))
inventories = client.getInventories()
```

## Development

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

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

## License

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