pyproject.toml

[build-system]
requires = ["hatchling", "hatch-vcs"]
build-backend = "hatchling.build"

[project]
name = "PyHamcrest"
description = "Hamcrest framework for matcher objects"
readme = "README.rst"
requires-python = ">= 3.8"
license = { file = "LICENSE.txt" }
keywords = [
  "hamcrest",
  "matchers",
  "pyunit",
  "unit",
  "test",
  "testing",
  "unittest",
  "unittesting",
]
authors = [
  { name = "Chris Rose", email="offline@offby1.net" },
  { name = "Simon Brunning", email="simon@brunningonline.net" },
  { name = "Jon Reid" },
]
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Environment :: Console",
  "Intended Audience :: Developers",
  "License :: OSI Approved :: BSD License",
  "Natural Language :: English",
  "Operating System :: OS Independent",
  "Programming Language :: Python :: 3",
  "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",
  "Programming Language :: Python :: Implementation :: CPython",
  "Programming Language :: Python :: Implementation :: Jython",
  "Programming Language :: Python :: Implementation :: PyPy",
  "Topic :: Software Development",
  "Topic :: Software Development :: Quality Assurance",
  "Topic :: Software Development :: Testing",
]
dynamic = ["version"]

[project.optional-dependencies]
docs = ["sphinx~=5.0", "alabaster~=0.7"]
tests = [
  "pytest>=5.0",
  "pytest-sugar",
  "pytest-xdist",
  "coverage[toml]",
  # No point on Pypy thanks to https://github.com/python/typed_ast/issues/111
  "pytest-mypy-plugins; platform_python_implementation != 'PyPy'",
  # Can't use 0.940: https://github.com/python/mypy/issues/12339
  "mypy<=1.10.1; platform_python_implementation != 'PyPy'",
  "types-mock",
  "pyyaml",
]
tests-numpy = [
  "PyHamcrest[tests]",
  "numpy",
]
dev = [
  "PyHamcrest[docs,tests]",
  "towncrier",
  "twine",
  "mypy<=1.10.1",
  "pytest-mypy",
  "flake8",
  "black",
  "tox",
  "tox-uv",
  "doc2dash",
]

[project.urls]
History = "https://github.com/hamcrest/PyHamcrest/blob/main/CHANGELOG.rst"
Source = "https://github.com/hamcrest/PyHamcrest/"
Issues = "https://github.com/hamcrest/PyHamcrest/issues"

[tool.hatch.version]
source = "vcs"
raw-options = { local_scheme = "no-local-version" }

[tool.hatch.build.hooks.vcs]
version-file = "src/hamcrest/_version.py"
template = """\
# coding: utf-8
# file generated by setuptools_scm
# don't change, don't track in version control
version = {version!r} # pragma: no mutate
version_tuple = {version_tuple!r} # pragma: no mutate
"""

[tool.hatch.build.targets.sdist]
exclude = [
  "/changelog.d/*.rst",
  "/release.sh",
  "/.github",
]
[tool.hatch.build.targets.wheel]
exclude = [
  "/examples",
]
packages = [
  "src/hamcrest",
]

[tool.coverage.run]
parallel = true
branch = true
source = ["hamcrest"]

[tool.coverage.paths]
source = ["src", ".tox/*/lib/*/site-packages"]

[tool.coverage.report]
show_missing = true
skip_covered = true
exclude_lines = [
    # a more strict default pragma
    "\\# pragma: no cover\\b",

    # allow defensive code
    "^\\s*raise AssertionError\\b",
    "^\\s*raise NotImplementedError\\b",
    "^\\s*return NotImplemented\\b",
    "^\\s*raise$",

    # typing-related code
    "^if (False|TYPE_CHECKING):",
    ": \\.\\.\\.(\\s*#.*)?$",
    "^ +\\.\\.\\.$",
    "-> ['\"]?NoReturn['\"]?:",
]

[tool.ruff]
exclude = [
    # re-ordering in this can lead to circular imports. No good!
    "src/hamcrest/__init__.py",
]
line-length = 100

[tool.ruff.lint]
ignore = [
       # We use star imports everywhere in this damn codebase
       "F405",
       "F403"
]

[tool.black]
line_length = 100

[tool.interrogate]
verbose = 2
fail-under = 100
whitelist-regex = ["test_.*"]

[tool.isort]
profile = "hamcrests"

known_first_party = "hamcrest"
known_third_party = ["hypothesis", "pytest", "setuptools", "six"]

[tool.towncrier]
    package = "hamcrest"
    package_dir = "src"
    filename = "CHANGELOG.rst"
    directory = "changelog.d"
    issue_format = "`#{issue} <https://github.com/hamcrest/PyHamcrest/issues/{issue}>`_"