pyproject.toml

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

[project]
authors = [
    {email = "ARC.Collaborations@ucl.ac.uk", name = "UCL ARC"},
]
classifiers = [
    "Operating System :: POSIX",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.11",
    "Typing :: Typed",
]
dependencies = [
    "Jinja2==3.1.2",
    "github3.py==4.0.1",
    "gitpython==3.1.36",
    "keyring==24.2.0",
    "loguru==0.7.2",
    "lxml==4.9.3",
    "python-docx==1.1.0",
    "python-frontmatter==1.0.1",
    "rich==13.6.0",
    "typer==0.9.0",
]
description = "Quality Workflow management helper. Automating traceability matrices"
dynamic = [
    "version",
]
keywords = [
]
name = "qw"
optional-dependencies = {dev = [
    "black",
    "build",
    "mypy",
    "pre-commit",
    "pytest",
    "ruff",
    "toml-sort",
    "tox>=4",
    "twine",
]}
readme = "README.md"
requires-python = ">=3.11"
license.file = "LICENCE.md"

[project.scripts]
qw = "qw.cli:run_app"

[project.urls]
homepage = "https://github.com/UCL-ARC/qw"

[tool.coverage]
report = {skip_covered = true, sort = "cover"}
run = {branch = true, parallel = true, source = [
    "qw",
]}
paths.source = [
    "src",
    ".tox*/*/lib/python*/site-packages",
]

[tool.mypy]
explicit_package_bases = true
plugins = [
    "numpy.typing.mypy_plugin",
    "pydantic.mypy",
]
# Allow union syntax for optionals
python_version = "3.11"

[tool.poetry]
authors = ["Stef Piatek", "Tim Band"]
description = "Tool to help regulatory compliance for projects hosted on github"
name = "qw"
readme = "README.md"
version = "0.1.0"

[tool.poetry.dependencies]
github3-py = "^4.0.1"
gitpython = "^3.1.36"
jinja2 = "^3.1.2"
keyring = "^24.2.0"
loguru = "^0.7.2"
lxml = "^4.9.3"
pytest = "^7.4.3"
pytest-cov = "^4.1.0"
python = "^3.9"
python-docx = "^1.0.1"
rich = "^13.6.0"
toml-sort = "^0.23.1"
typer = "^0.9.0"

[tool.poetry.group.dev.dependencies]
black = "^23.9.1"
build = "^1.0.3"
mypy = "^1.6.1"
pre-commit = "^3.4.0"
python-frontmatter = "^1.0.1"
ruff = "^0.0.290"
tox = "^4.11.3"
twine = "^4.0.2"

[tool.pytest.ini_options]
addopts = "--color=yes -v"
pythonpath = "src"
testpaths = [
    "tests",
]

[tool.ruff]
fix = true
force-exclude = true
ignore = [
    "D203", # no-blank-line-before-class
    "D212", # multi-line-summary-first-line
    "D417", # argument description in docstring (unreliable)
]
line-length = 120
select = [
    "A",
    "ARG",
    "B",
    "BLE",
    "C",
    "COM",
    "D",
    "DJ",
    "DTZ",
    "E",
    "EM",
    "ERA",
    "EXE",
    "F",
    "FBT",
    "I",
    "ICN",
    "ISC",
    "N",
    "NPY",
    "PD",
    "PGH",
    "PIE",
    "PL",
    "PT",
    "PTH",
    "PYI",
    "Q",
    "RET",
    "RSE",
    "RUF",
    "S",
    "SIM",
    "T",
    "TCH",
    "TID",
    "UP",
    "W",
    "YTT",
]
target-version = "py311"
isort.known-first-party = [
    "qw",
]
mccabe.max-complexity = 18
pep8-naming.classmethod-decorators = [
    "classmethod",
    "pydantic.validator",
]

[tool.ruff.per-file-ignores]
"cli.py" = [
    "FBT002", # default boolean function parameters (needed in Typer)
    "UP007", # Use X | None not Optional[X] (doesn't work in Typer)
]
"test_*" = [
    "S101",
]

[tool.setuptools_scm]
local_scheme = "no-local-version"
write_to = "src/qw/_version.py"

[tool.tomlsort]
all = true
spaces_indent_inline_array = 4
trailing_comma_inline_array = true
overrides."project.classifiers".inline_arrays = false
overrides."tool.coverage.paths.source".inline_arrays = false

[tool.tox]
legacy_tox_ini = """
    [gh-actions]
    python =
        3.11: py311

    [testenv]
    commands =
        pytest --cov --cov-report=xml
    deps =
        pytest
        pytest-cov
        python-docx

    [tox]
    env_list =
        py311
"""