pyproject.toml

[build-system]
requires = ["setuptools>=64", "setuptools_scm[toml]>=8"]
build-backend = "setuptools.build_meta"

[project]
name = "event-model"
classifiers = [
  "Development Status :: 3 - Alpha",
  "License :: OSI Approved :: BSD License",
  "Programming Language :: Python :: 3.8",
  "Programming Language :: Python :: 3.9",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
]
description = "Data model used by the bluesky ecosystem."
dependencies = [
  "importlib-resources",
  "jsonschema>=4",
  "numpy",
  "typing_extensions",
]
dynamic = ["version"]
license.file = "LICENSE"
readme = "README.md"
requires-python = ">=3.8"

[project.optional-dependencies]
dev = [
  "mypy",
  "myst-parser",
  "pipdeptree",
  "pre-commit",
  "pydata-sphinx-theme>=0.12",
  "pytest",
  "pytest-cov",
  "ruff",
  "sphinx-autobuild",
  "sphinx-copybutton",
  "sphinx-design",
  "tox-direct",
  "types-mock",

  # For updating the copier template.
  "copier",

  # These are dependencies of various sphinx extensions for documentation.
  "ipython",
  "matplotlib",
  "numpydoc",

  # For schema generation.
  "pydantic<3",
  "datamodel-code-generator",
]

[project.urls]
GitHub = "https://github.com/bluesky/event-model"

[[project.authors]] # Further authors may be added by duplicating this section
email = "dallan@bnl.gov"
name = "Brookhaven National Lab"

[tool.setuptools_scm]
version_file = "src/event_model/_version.py"

[tool.mypy]
ignore_missing_imports = true # Ignore missing stubs in imported modules

[tool.pytest.ini_options]
# Run pytest with all our checkers, and don't spam us with massive tracebacks on error
addopts = """
    --tb=native -vv
    --cov=src/event_model --cov-report term --cov-report xml:cov.xml
    """
# https://iscinumpy.gitlab.io/post/bound-version-constraints/#watch-for-warnings
filterwarnings = "error"
# Doctest python code in docs, python code in src docstrings, test functions in tests
testpaths = "src/event_model/tests"

[tool.coverage.run]
data_file = "/tmp/event_model.coverage"

[tool.coverage.paths]
# Tests are run from installed location, map back to the src directory
source = ["src", "**/site-packages/"]

# tox must currently be configured via an embedded ini string
# See: https://github.com/tox-dev/tox/issues/999
[tool.tox]
legacy_tox_ini = """
[tox]
skipsdist=True

[testenv:{pre-commit,type-checking,tests,docs}]
# Don't create a virtualenv for the command, requires tox-direct plugin
direct = True
passenv = *
allowlist_externals =
    pytest
    pre-commit
    mypy
    sphinx-build
    sphinx-autobuild
commands =
    pre-commit: pre-commit run --all-files --show-diff-on-failure {posargs}
    type-checking: mypy src/event_model {posargs}
    tests: pytest --cov=src/event_model --cov-report term --cov-report xml:cov.xml {posargs}
    docs: sphinx-{posargs:build -E --keep-going} -T docs build/html
"""

[tool.ruff]
src = ["src"]
line-length = 88
lint.select = [
  "B",   # flake8-bugbear - https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
  "C4",  # flake8-comprehensions - https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
  "E",   # pycodestyle errors - https://docs.astral.sh/ruff/rules/#error-e
  "F",   # pyflakes rules - https://docs.astral.sh/ruff/rules/#pyflakes-f
  "W",   # pycodestyle warnings - https://docs.astral.sh/ruff/rules/#warning-w
  "I",   # isort - https://docs.astral.sh/ruff/rules/#isort-i
  "UP",  # pyupgrade - https://docs.astral.sh/ruff/rules/#pyupgrade-up
  "SLF", # self - https://docs.astral.sh/ruff/settings/#lintflake8-self
]

[tool.ruff.lint.per-file-ignores]
# By default, private member access is allowed in tests
# See https://github.com/DiamondLightSource/python-copier-template/issues/154
"src/event_model/tests/**" = ["SLF001"]