forked from pykeen/pykeen
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tox.ini
230 lines (209 loc) 路 5.19 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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# Tox (http://tox.testrun.org/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
[tox]
envlist =
# always keep coverage-clean first
#coverage-clean
# code linters/stylers
lint
manifest
flake8
darglint
pyroma
# documentation linters/checkers
readme
doc8
docs
# the actual tests
doctests
py
integration
# always keep coverage-report last
#coverage-report
[testenv]
commands = coverage run -p -m pytest --durations=20 {posargs:tests} -m "not slow"
passenv =
HOME
extras =
mlflow
tensorboard
tests
whitelist_externals =
/bin/cat
/bin/cp
/bin/mkdir
/usr/bin/cat
/usr/bin/cp
/usr/bin/mkdir
/usr/bin/git
/usr/local/bin/git
[testenv:integration]
commands = coverage run -p -m pytest --durations=20 {posargs:tests} -m slow
extras =
mlflow
tests
[testenv:doctests]
commands =
# TODO make this automatic for all RST in a loop (but not using xargs since doctest uses multiprocessing)
python -m doctest docs/source/tutorial/running_ablation.rst
python -m doctest docs/source/tutorial/first_steps.rst
python -m doctest docs/source/byo/data.rst
python -m doctest docs/source/byo/interaction.rst
python -m doctest docs/source/tutorial/making_predictions.rst
xdoctest -m src/pykeen/utils.py
xdoctest -m src/pykeen/pipeline/api.py
# xdoctest -m src/pykeen/hpo/__init__.py
deps =
xdoctest
pygments
[testenv:coverage-clean]
deps = coverage
skip_install = true
commands = coverage erase
[testenv:manifest]
deps = check-manifest
skip_install = true
commands = check-manifest
[testenv:lint]
deps =
black
isort
skip_install = true
commands =
black src/ tests/ setup.py
isort src/ tests/ setup.py
description = Run linters.
[testenv:flake8]
skip_install = true
deps =
flake8<4.0.0
flake8-bandit
flake8-black
flake8-bugbear
flake8-colors
flake8-docstrings<1.6
flake8-isort
flake8-print
pep8-naming
pydocstyle
commands =
flake8 src/pykeen/ tests/ setup.py
description = Run the flake8 tool with several plugins (bandit, docstrings, import order, pep8 naming).
[testenv:docstr-coverage]
skip_install = true
deps =
docstr-coverage
commands =
docstr-coverage --skip-private --skip-magic \
src/pykeen/datasets/ \
src/pykeen/models/predict.py \
src/pykeen/utils.py \
src/pykeen/datasets/ \
src/pykeen/triples/utils.py \
src/pykeen/ablation/ \
setup.py
description = Run the docstr-coverage tool to check documentation coverage
[testenv:darglint]
skip_install = true
deps =
flake8
flake8-colors
darglint
commands =
flake8 \
src/pykeen/models/predict.py \
src/pykeen/models/nbase.py \
src/pykeen/utils.py \
src/pykeen/datasets/ \
src/pykeen/triples/utils.py \
src/pykeen/pipeline/ \
src/pykeen/sampling/ \
src/pykeen/models/unimodal/ \
src/pykeen/losses.py \
src/pykeen/ablation/ \
tests/test_sampling/ \
tests/test_training/ \
setup.py
description = Run the flake8 tool with darglint.
[testenv:mypy]
deps =
mypy
skip_install = true
commands = mypy --install-types --non-interactive --ignore-missing-imports src/pykeen setup.py
description = Run the mypy tool to check static typing on the project.
[testenv:pyroma]
deps =
pygments
pyroma
skip_install = true
commands = pyroma --min=9 .
description = Run the pyroma tool to check the package friendliness of the project.
[testenv:readme]
commands = pykeen readme --check
usedevelop = true
extras =
templating
description = Make sure readme has been updated properly
[testenv:doc8]
skip_install = true
deps =
sphinx
doc8
commands =
doc8 docs/source/ CHANGELOG.rst
description = Run the doc8 tool to check the style of the RST files in the project docs.
[testenv:docs]
changedir = docs
extras =
docs
commands =
mkdir -p {envtmpdir}
cp -r source {envtmpdir}/source
python -m sphinx -W -b html -d {envtmpdir}/build/doctrees {envtmpdir}/source {envtmpdir}/build/html
python -m sphinx -W -b coverage -d {envtmpdir}/build/doctrees {envtmpdir}/source {envtmpdir}/build/coverage
cat {envtmpdir}/build/coverage/c.txt
cat {envtmpdir}/build/coverage/python.txt
[testenv:coverage-report]
deps = coverage
skip_install = true
commands =
coverage combine
coverage report
####################
# Deployment tools #
####################
[testenv:bumpversion]
commands = bumpversion {posargs}
skip_install = true
passenv = HOME
deps =
bumpversion
[testenv:build]
skip_install = true
deps =
wheel
setuptools
commands =
python setup.py -q sdist bdist_wheel
[testenv:release]
skip_install = true
deps =
{[testenv:build]deps}
twine >= 1.5.0
commands =
{[testenv:build]commands}
twine upload --skip-existing dist/*
[testenv:finish]
skip_install = true
passenv = HOME
deps =
{[testenv:release]deps}
bumpversion
commands =
bumpversion release
{[testenv:release]commands}
git push
bumpversion patch
git push