-
Notifications
You must be signed in to change notification settings - Fork 22
/
tox.ini
93 lines (82 loc) · 2.71 KB
/
tox.ini
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# Tox configuration file
# Read more under https://tox.wiki/
[tox]
minversion = 3.24
envlist = py37,py38,py39,py310
isolated_build = True
[testenv]
description = Invoke pytest to run automated tests
setenv =
TOXINIDIR = {toxinidir}
passenv =
HOME
SETUPTOOLS_*
extras =
dev
commands =
pytest {posargs}
pytest src/ --doctest-modules
python tests/nb_eval.py --nb_dir .
# To run `tox -e lint` you need to make sure you have a
# `.pre-commit-config.yaml` file. See https://pre-commit.com
[testenv:lint]
description = Perform static analysis and style checks
skip_install = True
deps = pre-commit
passenv =
HOMEPATH
PROGRAMDATA
SETUPTOOLS_*
commands =
pre-commit run --all-files {posargs:--show-diff-on-failure}
[testenv:{build,clean}]
description =
build: Build the package in isolation according to PEP517, see https://github.com/pypa/build
clean: Remove old distribution files and temporary build artifacts (./build and ./dist)
# https://setuptools.pypa.io/en/stable/build_meta.html#how-to-use-it
skip_install = True
changedir = {toxinidir}
deps =
build: build[virtualenv]
passenv =
SETUPTOOLS_*
commands =
clean: python -c 'import shutil; [shutil.rmtree(p, True) for p in ("build", "dist", "docs/_build")]'
clean: python -c 'import pathlib, shutil; [shutil.rmtree(p, True) for p in pathlib.Path("src").glob("*.egg-info")]'
build: python -m build {posargs}
[testenv:{docs,doctests,linkcheck}]
description =
docs: Invoke sphinx-build to build the docs
doctests: Invoke sphinx-build to run doctests
linkcheck: Check for broken links in the documentation
passenv =
SETUPTOOLS_*
setenv =
DOCSDIR = {toxinidir}/docs
BUILDDIR = {toxinidir}/docs/_build
docs: BUILD = html
doctests: BUILD = doctest
linkcheck: BUILD = linkcheck
extras =
dev
commands =
python {env:DOCSDIR}/pre_build.py
sphinx-build --color -b {env:BUILD} -d "{env:BUILDDIR}/doctrees" "{env:DOCSDIR}" "{env:BUILDDIR}/{env:BUILD}" {posargs}
# NOTE: We do not use tox for publishing the library (we use GitHub Actions workflows). This is for reference only.
# [testenv:publish]
# description =
# Publish the package you have been developing to a package index server.
# By default, it uses testpypi. If you really want to publish your package
# to be publicly accessible in PyPI, use the `-- --repository pypi` option.
# skip_install = True
# changedir = {toxinidir}
# passenv =
# # See: https://twine.readthedocs.io/en/latest/
# TWINE_USERNAME
# TWINE_PASSWORD
# TWINE_REPOSITORY
# TWINE_REPOSITORY_URL
# deps = twine
# commands =
# python -m twine check dist/*
# python -m twine upload {posargs:--repository {env:TWINE_REPOSITORY:testpypi}} dist/*