pyproject.toml

[build-system]
requires = ["setuptools>=64", "setuptools-scm>=8.0"]
build-backend = "setuptools.build_meta"

[project]
name = "openedx-authz"
description = "Open edX AuthZ provides the architecture and foundations of the authorization framework."
readme = "README.rst"
license = "AGPL-3.0-or-later"
license-files = ["LICENSE"]
authors = [
    {name = "Open edX Project", email = "oscm@openedx.org"},
]
requires-python = ">=3.12"
classifiers = [
    "Development Status :: 3 - Alpha",
    "Framework :: Django",
    "Framework :: Django :: 4.2",
    "Framework :: Django :: 5.2",
    "Intended Audience :: Developers",
    "Natural Language :: English",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.12",
]
dynamic = ["version"]
dependencies = [
    "attrs",
    "casbin-django-orm-adapter",
    "Django>=4.2,<6.0",
    "django-crum",
    "django-waffle",
    "djangorestframework",
    "edx-api-doc-tools",
    "edx-ccx-keys",
    "edx-django-utils",
    "edx-drf-extensions",
    "edx-opaque-keys",
    "edx-organizations",
    "openedx-atlas",
    "openedx-events",
    "openedx-filters>=3.15.0",
    "pycasbin",
]

[project.urls]
Homepage = "https://github.com/openedx/openedx-authz"

[project.entry-points."lms.djangoapp"]
openedx_authz = "openedx_authz.apps:OpenedxAuthzConfig"

[project.entry-points."cms.djangoapp"]
openedx_authz = "openedx_authz.apps:OpenedxAuthzConfig"

# Static authorization schema resources contributed by this package (ADR 0019).
# openedx-authz is a schema provider like any other distribution; the callable
# returns resource paths relative to the openedx_authz.authz module.
[project.entry-points."authz.schema"]
openedx_authz = "openedx_authz.authz:get_schema_resources"

[tool.setuptools_scm]
version_scheme = "only-version"
local_scheme = "no-local-version"
fallback_version = "0.0.0"

[tool.setuptools]
include-package-data = true
# Packages live in src/ but are installed without the src prefix,
# e.g. src/openedx_authz/ is installed as openedx_authz.
package-dir = {"" = "src"}

[tool.setuptools.packages.find]
where = ["src"]
exclude = ["*tests*"]

[tool.setuptools.exclude-package-data]
"*" = ["tests*", "*.tests*", "spec*", "*.spec*"]

[tool.isort]
include_trailing_comma = true
indent = "    "
line_length = 120
multi_line_output = 3
skip = ["migrations"]

[tool.coverage.run]
branch = true
source = ["src/openedx_authz"]
omit = [
    "*/migrations/*",
    "*admin.py",
    "*/static/*",
    "*/templates/*",
    "*/tests/*",
    "*/settings/*",
]

[tool.coverage.report]
show_missing = true
exclude_lines = [
    "pragma: no cover",
    "def __repr__",
    "raise AssertionError",
    "raise NotImplementedError",
    "if __name__ == .__main__.:",
    "if TYPE_CHECKING:",
]

[tool.coverage.html]
directory = "htmlcov"

[dependency-groups]
# Base test packages, no version pins - let uv.lock handle it
test-base = [
    "code-annotations",
    "coverage",
    "ddt",
    "pytest-cov",
    "pytest-django",
]
# The currently supported/default Django version.
test = [
    {include-group = "test-base"},
    "Django>=5.2,<6.0",
]
quality = [
    {include-group = "test"},
    "edx-lint",
    "pydocstyle",
    "ruff",
]
doc = [
    {include-group = "test"},
    "build",
    "doc8",
    "Sphinx",
    "sphinx-book-theme",
    "sphinx-jsonschema",
    "twine",
]
# Minimal CI group: just what's needed to invoke tox.
ci = [
    "tox",
    "tox-uv",
]
dev = [
    {include-group = "quality"},
    {include-group = "ci"},
    {include-group = "doc"},
    "diff-cover",
    "edx-i18n-tools",
]

[tool.uv]
package = true

#  DO NOT EDIT constraint-dependencies DIRECTLY.
#  This list is managed by `edx_lint write_uv_constraints`
#  and will be overwritten the next time `make upgrade` is run.
#  - GLOBAL constraints: edit edx_lint/files/common_constraints.txt
#  - REPO-SPECIFIC constraints: edit [tool.edx_lint].uv_constraints in this file
constraint-dependencies = [
    "Django<6.0",
    "elasticsearch<7.14.0",
    "social-auth-app-django<6.0.0",
    "social-auth-core<5.0.0",
    "pip<26.2.1",
]

[tool.edx_lint]
uv_constraints = []

[tool.semantic_release]
build_command = "python -m pip install --upgrade build && SETUPTOOLS_SCM_PRETEND_VERSION=$NEW_VERSION python -m build"
major_on_zero = false
allow_zero_version = true
tag_format = "v{version}"