Metadata-Version: 2.4
Name: entirius-django-reviews
Version: 2.0.0
Summary: Product reviews and ratings for Django with a REST API and optional Magento export
Project-URL: Repository, https://github.com/entirius/entirius-django-reviews
Author: Entirius
License-Expression: MPL-2.0
License-File: LICENSE
Requires-Python: >=3.11
Requires-Dist: django>=5.0
Requires-Dist: entirius-django-accounts>=5.0.0
Requires-Dist: entirius-django-pim>=3.0.0
Requires-Dist: entirius-django-utils>=2.0.0
Requires-Dist: entirius-py-bievents>=2.0.0
Requires-Dist: entirius-py-process-logger>=2.0.0
Requires-Dist: marshmallow-dataclass>=8.5
Requires-Dist: marshmallow>=3.19
Requires-Dist: tqdm>=4.60
Provides-Extra: dev
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Provides-Extra: magento
Requires-Dist: entirius-py-magento2-sdk2>=2.0.0; extra == 'magento'
Provides-Extra: test
Requires-Dist: entirius-django-captcha>=2.0.0; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-django; extra == 'test'
Description-Content-Type: text/markdown

# entirius-django-reviews

Product reviews and ratings for Django.

A REST API for submitting and listing product reviews, admin moderation, average-rating
aggregation per product, and optional export of reviews to Magento.

## Installation

```shell
pip install entirius-django-reviews
```

Add `django_reviews` to `INSTALLED_APPS` and include `django_reviews.urls`.

The `Review` model references `django_accounts.Customer`, so `entirius-django-accounts`
must be installed and migrated. Magento export is optional:

```shell
pip install "entirius-django-reviews[magento]"
```

## Development

```shell
uv sync --all-extras
make check test
```

See [AGENTS.md](AGENTS.md) for architecture, settings and integration points.
