mongoose/tox.ini at main · PiRogueToolSuite/mongoose · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# SPDX-FileCopyrightText: 2026 Defensive Lab Agency
# SPDX-FileContributor: u039b <git@0x39b.fr>
#
# SPDX-License-Identifier: GPL-3.0-or-later

[tox]
requires =
    tox>=4.2
    uv>=0.4.10
    tox-uv>=1.11.3
env_list =
    3.11
    3.12
    3.13
isolated_build = False

[testenv]
description = run the unit tests with pytest under {base_python}
usedevelop = true
dependency_groups =
    test
allowlist_externals =
    bash
commands =
    coverage run -m pytest tests/ --doctest-modules --md-report --md-report-verbose=0 --md-report-output test-report.md
    bash -c "coverage report --format=markdown | tee test-coverage.md"
    bash -c "coverage xml"

[testenv:fix]
description = format the code base to adhere to our styles, and complain about what we cannot do automatically
skip_install = true
dependency_groups =
    dev
    test
commands =
    ruff format
    pre-commit run --all-files

[testenv:type]
description = run type check on code base
dependency_groups =
    test
commands =
    mypy mongoose

[testenv:docs]
description = generate documentation
dependency_groups =
    docs
commands =
    sphinx-build -M html ./docs docs/_build/
    sphinx-build -M linkcheck ./docs docs/_build/

[testenv:apidoc]
description = generate API documentation
dependency_groups =
    docs
commands =
    sphinx-apidoc -f --remove-old -e -o ./docs/source/ ./mongoose/

[testenv:servedocs]
description = serve documentation
dependency_groups =
    docs
commands =
    sphinx-autobuild --watch mongoose  docs/ docs/_build/html