pyproject.toml

[build-system]
requires = [ "setuptools >= 35.0.2", "wheel >= 0.29.0", "setuptools_scm[toml]==7.0.5"]
build-backend = "setuptools.build_meta"



[project]
name = "hydra_zen"
dynamic = ["version"]
description = "Configurable, reproducible, and scalable workflows in Python, via Hydra"
readme = "README.md"
requires-python = ">=3.7"
dependencies=[
  "hydra-core >= 1.1.0",
  "typing-extensions >= 4.1.0",
]
license = {text = "MIT"}
keywords= [ "machine learning", "research", "configuration", "scalable", "reproducible", "yaml", "Hydra", "dataclass"]

authors = [
  {name = "Ryan Soklaski", email = "ryan.soklaski@ll.mit.edu" },
  {name = "Justin Goodwin", email = "jgoodwin@ll.mit.edu" },
]
maintainers = [
  {name = "Ryan Soklaski", email = "ryan.soklaski@ll.mit.edu" },
]

classifiers = [
    "Development Status :: 4 - Beta",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
    "Intended Audience :: Science/Research",
    "Programming Language :: Python :: 3.7",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Topic :: Scientific/Engineering",
    "Programming Language :: Python :: 3 :: Only",
]

[project.optional-dependencies]
test = [
    "pytest >= 3.8",
    "hypothesis >= 6.28.0",
]
pydantic = ["pydantic>=1.8.2"]
beartype = ["beartype>=0.8.0"]

[project.urls]
"Homepage" = "https://mit-ll-responsible-ai.github.io/hydra-zen/"
"Bug Reports" = "https://github.com/mit-ll-responsible-ai/hydra-zen/issues"
"Source" = "https://github.com/mit-ll-responsible-ai/hydra-zen"



[tool.setuptools_scm]
write_to = "src/hydra_zen/_version.py"
version_scheme = "no-guess-dev"



[tool.setuptools]
package-dir = {"" = "src"}

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

[tool.setuptools.package-data]
hydra_zen = ["py.typed"]



[tool.isort]
known_first_party = ["hydra_zen", "tests"]
profile = "black"
combine_as_imports = true



[tool.coverage.run]
branch = true
omit = [
  "tests/test_docs_typecheck.py",
]

[tool.coverage.report]
omit = ["src/hydra_zen/_version.py"]
exclude_lines = [
  'pragma: no cover',
  'def __repr__',
  'raise NotImplementedError',
  'class .*\bProtocol(\[.+\])?\):',
  '@(abc\.)?abstractmethod',
  '@(typing\.)?overload',
  'except ImportError:',
  'except ModuleNotFoundError:',
  'if (typing\.)?TYPE_CHECKING:',
  'if sys\.version_info',
]

[tool.pytest.ini_options]
xfail_strict=true


[tool.pyright]
include = ["src"]
exclude = [
       "**/node_modules",
       "**/__pycache__",
       "src/hydra_zen/_version.py",
       "**/third_party",
]
reportUnnecessaryTypeIgnoreComment = true
reportUnnecessaryIsInstance = false


[tool.codespell]
skip = 'docs/build/*'

[tool.tox]
legacy_tox_ini = """
[tox]
isolated_build = True
envlist = py37, py38, py39, py310, py311

[gh-actions]
python =
  3.7: py37
  3.8: py38
  3.9: py39
  3.10: py310
  3.11: py311


[testenv]
passenv = *
deps = pytest
       hypothesis
       pytest-xdist
commands = pytest -n auto tests/ {posargs}


[testenv:min-deps]  # test against minimum dependency versions
deps = hydra-core==1.1.0
       omegaconf==2.1.1
       typing-extensions==4.1.0
       {[testenv]deps}
basepython = python3.7


[testenv:pre-release]  # test against pre-releases of dependencies
pip_pre = true
deps = {[testenv]deps}
       pydantic
       beartype
       cloudpickle
basepython = python3.8

[testenv:omegaconf-2p2p2]  # guard against regressions for type sanitization
pip_pre = true
deps = omegaconf==2.2.2
       {[testenv]deps}
       pydantic
       beartype
       cloudpickle
basepython = python3.8

[testenv:coverage]
setenv = NUMBA_DISABLE_JIT=1
usedevelop = true
basepython = python3.10
deps = {[testenv]deps}
       coverage[toml]
       pytest-cov
       numpy
       pydantic
       beartype
       cloudpickle
commands = pytest --cov-report term-missing --cov-config=pyproject.toml --cov-fail-under=100 --cov=hydra_zen -n auto tests


[testenv:pyright-scan-docs]
usedevelop = true
basepython = python3.9
deps = {[testenv]deps}
       torch
       pytorch-lightning
       numpy
       jaxlib
       jax
       pydantic
       beartype
       pyright
commands = pytest -n auto tests/test_docs_typecheck.py -vv


[testenv:third-party]
install_command = pip install --upgrade --upgrade-strategy eager {opts} {packages}
basepython = python3.9
deps = {[testenv]deps}
       torch
       pytorch-lightning
       numpy
       jaxlib
       jax
       pydantic
       beartype

[testenv:typecheck]
usedevelop = true
basepython = python3.9
deps = pyright==1.1.282
       mypy==0.982

commands = pyright --lib tests/annotations/ src/
           pyright --ignoreexternal --verifytypes hydra_zen
           mypy --warn-unused-ignores --non-interactive --install-types tests/annotations/mypy_checks.py

[testenv:format]
skip_install=true
deps =
    autoflake
    black
    isort
commands =
    autoflake --recursive --in-place --remove-duplicate-keys --remove-unused-variables src/ tests/
    isort src/ tests/
    black src/ tests/

[testenv:docs]
basepython=python3.9
changedir=docs
deps=-r{toxinidir}/docs/requirements.txt
commands=
    sphinx-build -b html -d {envtmpdir}/doctrees ./source  {envdir}/build/html

[testenv:enforce-format]
skip_install=true
basepython=python3.9
deps=black
     isort
     flake8
     pytest
     codespell
commands=
    black src/ tests/ --diff --check
    isort src/ tests/ --diff --check
    flake8 src/ tests/
    codespell src/ docs/
    pytest project_tooling/test_headers.py 
"""