pyproject.toml

# ─────────────────────────────────────────────────────────────────────────────
# ERE Prototype Template — Project Configuration
# ─────────────────────────────────────────────────────────────────────────────
# This file defines the Python project metadata, dependencies, build system,
# and tool configurations for the ERE prototype template.
#
# Managed by Poetry (https://python-poetry.org/).
# Install: poetry install
# Run:     poetry run python -m ere.main
# Test:    poetry run pytest
# ─────────────────────────────────────────────────────────────────────────────

[project]
name = "ere-prototype-template"
version = "1.0.0"
description = """
  A modular, configurable Entity Resolution Engine (ERE) prototype template.

  Implements the ERS–ERE contract defined in entity-resolution-spec,
  providing a working skeleton for building conformant ERE implementations.
"""
authors = [
    {name = "ERE Developer", email = "ere@ted.europa.eu"}
]
readme = "README.md"
license = "EUPL-1.2"
requires-python = ">=3.12"

# ─── Runtime Dependencies ────────────────────────────────────────────────────
# These are installed in the production Docker image.
[tool.poetry.dependencies]
python = ">=3.12,<4.0"
# Pydantic: Data validation and serialization for message models.
pydantic = ">=2.10.6,<3.0.0"
# PyYAML: YAML configuration file parsing.
pyyaml = ">=6.0,<7.0"
# Redis: Client library for the Redis message broker.
redis = ">=5.0,<6.0"
# sentence-transformers: Hugging Face embedding models for text similarity.
sentence-transformers = ">=3.0,<4.0"
# rdflib: Standard Python library for RDF parsing (Turtle, N-Triples, etc.)
rdflib = ">=7.0,<8.0"
# huggingface-hub: Model download and caching support.
huggingface-hub = ">=0.23,<1.0"
# pymongo: MongoDB driver for the MongoDB storage backend.
# Note: MongoDB 8.x uses SSPL license. FerretDB (Apache 2.0) is a compatible alternative.
pymongo = {version = ">=4.7,<5.0", optional = true}
# psycopg: PostgreSQL driver for the PostgreSQL + pgvector storage backend.
psycopg = {version = ">=3.1,<4.0", extras = ["binary"], optional = true}

# ─── Optional Dependency Groups (extras) ─────────────────────────────────────
# Install specific storage backends:
#   poetry install --extras mongodb
#   poetry install --extras postgres
#   poetry install --extras "mongodb postgres"
[tool.poetry.extras]
mongodb = ["pymongo"]
postgres = ["psycopg"]
all-storage = ["pymongo", "psycopg"]

# ─── Development Dependencies ────────────────────────────────────────────────
# These are NOT installed in the production Docker image.
[dependency-groups]
dev = [
    # pytest: Test framework.
    "pytest (>=8.0,<9.0)",
    # pytest-bdd: BDD/Gherkin test support.
    "pytest-bdd (>=7.0,<8.0)",
    # pytest-asyncio: Async test support (required by pytest-bdd internals).
    "pytest-asyncio (>=0.23,<1.0)",
    # ruff: Fast Python linter and formatter.
    "ruff (>=0.9.0,<1.0.0)",
    # coverage: Test coverage measurement and reporting.
    "coverage (>=7.0,<8.0)",
    # hypothesis: Property-based testing framework.
    "hypothesis (>=6.0,<7.0)",
]

# ─── Build System ────────────────────────────────────────────────────────────
[build-system]
requires = ["poetry-core>=2.0.0,<3.0.0"]
build-backend = "poetry.core.masonry.api"

# ─── Poetry Package Configuration ───────────────────────────────────────────
[tool.poetry]
# The ere/ directory is the installable Python package.
packages = [
  { include = "ere" }
]

# ─── Ruff Linter Configuration ──────────────────────────────────────────────
[tool.ruff]
# Target Python 3.12 for syntax and feature detection.
target-version = "py312"

# ─── Pytest Configuration ────────────────────────────────────────────────────
[tool.pytest.ini_options]
# Default test discovery path.
testpaths = ["tests"]
# Custom markers for selective test execution.
markers = [
    "unit: Unit tests (fast, no external dependencies)",
    "integration: Integration tests (may require external services)",
    "bdd: BDD feature tests (Gherkin scenarios)",
]
# Suppress warnings from third-party packages that haven't adapted to Python 3.14 yet.
filterwarnings = [
    "ignore:'maxsplit' is passed as positional argument:DeprecationWarning",
    "ignore:usefixtures\\(\\).*without arguments has no effect:pytest.PytestWarning",
]