Metadata-Version: 2.5
Name: entirius-django-pim
Version: 3.4.0
Summary: Product information module for Entirius: products, categories, features, attributes and media per sales channel
Project-URL: Homepage, https://docs.entirius.com/
Project-URL: Documentation, https://github.com/entirius/entirius-django-pim/tree/develop/docs
Project-URL: Repository, https://github.com/entirius/entirius-django-pim
Project-URL: Changelog, https://github.com/entirius/entirius-django-pim/blob/develop/CHANGELOG.md
Project-URL: Issues, https://github.com/entirius/entirius-django-pim/issues
Author: Entirius
License-Expression: MPL-2.0
License-File: LICENSE
Keywords: django,ecommerce,entirius,headless,pim,product-catalog
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Framework :: Django :: 5.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Office/Business
Requires-Python: >=3.11
Requires-Dist: celery>=5.4
Requires-Dist: django-admin-inline-paginator>=0.3.0
Requires-Dist: django-filter>=23.0
Requires-Dist: django>=5.0
Requires-Dist: djangorestframework-simplejwt>=5.3
Requires-Dist: djangorestframework>=3.14
Requires-Dist: drf-spectacular>=0.27
Requires-Dist: entirius-django-regional>=2.0.0
Requires-Dist: entirius-django-utils>=2.0.0
Requires-Dist: entirius-py-bievents>=2.0.0
Requires-Dist: entirius-py-idx-normalizator>=2.0.0
Requires-Dist: entirius-py-image-transformations>=2.0.0
Requires-Dist: entirius-py-int-enum-choices>=2.0.0
Requires-Dist: entirius-py-process-logger>=2.0.0
Requires-Dist: opencv-contrib-python>=4.5
Requires-Dist: pillow>=9.1.0
Requires-Dist: pydantic>=2.0
Requires-Dist: python-magic
Requires-Dist: python-slugify
Requires-Dist: pytz
Requires-Dist: pyyaml
Requires-Dist: requests
Requires-Dist: trafaret
Requires-Dist: urllib3
Provides-Extra: dev
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Provides-Extra: test
Requires-Dist: dj-database-url; extra == 'test'
Requires-Dist: factory-boy; extra == 'test'
Requires-Dist: psycopg[binary]; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-django; extra == 'test'
Description-Content-Type: text/markdown

# entirius-django-pim

A Django module for product information of Entirius, the open-source modular ecommerce platform: the product
catalog behind every sales channel. It stores products, categories, features, attributes and media, and serves them
to the admin CMS over a REST API.

[![PyPI](https://img.shields.io/pypi/v/entirius-django-pim.svg)](https://pypi.org/project/entirius-django-pim/)
[![Python](https://img.shields.io/pypi/pyversions/entirius-django-pim.svg)](https://pypi.org/project/entirius-django-pim/)
[![License: MPL-2.0](https://img.shields.io/badge/license-MPL--2.0-blue.svg)](https://github.com/entirius/entirius-django-pim/blob/develop/LICENSE)

## What it does

- Stores products per sales channel on top of one shared physical product (SKU, EAN, dimensions).
- Models simple, configurable, bundle and custom products, with categories, features, feature sets and attributes.
- Manages pictures, files, videos and product links.
- Lets products on secondary channels inherit attributes, descriptions and media from a default channel.
- Reports quality gaps: what each product is missing, per channel and language, by configurable rules.
- Exposes an admin REST API with an OpenAPI schema.

## Installation

```shell
uv add entirius-django-pim
pip install entirius-django-pim
```

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

# urls.py
urlpatterns = [
    path("", include("django_pim.urls")),
]
```

The module reads `MEDIA_URL`, `STATIC_URL` and `TMP_DIR` (a directory for file and picture processing) from the
project settings at import time. Optional settings (`T9N_DEFAULT_LANG`, `DEFAULT_CURRENCY`, `THUMBS_CONFIG`,
`PIM_GAPS_QUEUE` and others) and their defaults are in
https://github.com/entirius/entirius-django-pim/blob/develop/src/django_pim/settings.py

## Quick start

```python
from django_pim.services.product_service import get_product_by_sku

product = get_product_by_sku(channel_idx="default", sku="SKU-001")
print(product.visibility, product.is_enabled)
```

## Requirements

- Python 3.11 or newer, Django 5.0 or newer.
- PostgreSQL 15 or newer (`UniqueConstraint(nulls_distinct=False)`).
- Entirius packages pulled in: `entirius-django-regional`, `entirius-django-utils`, `entirius-py-bievents`,
  `entirius-py-idx-normalizator`, `entirius-py-int-enum-choices`, `entirius-py-image-transformations`,
  `entirius-py-process-logger`.

## Documentation

- Module docs: https://github.com/entirius/entirius-django-pim/tree/develop/docs
- Entirius documentation: https://docs.entirius.com/
- Changelog: https://github.com/entirius/entirius-django-pim/blob/develop/CHANGELOG.md

## Part of Entirius

This module runs inside the Entirius backend service (Volkanos) and is the catalog most other modules build on.

- Backend service: https://github.com/entirius/entirius-service-volkanos
- Docker harness: https://github.com/entirius/entirius-zeno
- Sibling modules: https://github.com/entirius/entirius-django-regional,
  https://github.com/entirius/entirius-django-utils, https://github.com/entirius/entirius-django-contentdb

## Development

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

Development and agent instructions: https://github.com/entirius/entirius-django-pim/blob/develop/AGENTS.md

## License

Mozilla Public License 2.0 (MPL-2.0) — see https://github.com/entirius/entirius-django-pim/blob/develop/LICENSE.
