Skip to content

Commit 088434e

Browse files
authored
Drop tox (#384)
* Use `.flake8` to configure Flake8 * Remove `tox.ini` * Drop `tox` from test requirements * Drop `tox` from contributing docs * Drop `.tox` from `.gitignore` * Remove tox from `.github` PR template * Mention dropping tox in release notes
1 parent 7cfd52e commit 088434e

File tree

7 files changed

+13
-54
lines changed

7 files changed

+13
-54
lines changed

.flake8

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[flake8]
2+
max-line-length = 100

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
TODO:
44

55
- [ ] Unit tests and/or doctests in docstrings
6-
- [ ] `tox -e py310` passes locally
6+
- [ ] Tests pass locally
77
- [ ] Docstrings and API docs for any new/modified user-facing classes and functions
88
- [ ] Changes documented in docs/release.rst
9-
- [ ] `tox -e docs` passes locally
9+
- [ ] Docs build locally
1010
- [ ] GitHub Actions CI passes
1111
- [ ] Test coverage to 100% (Coveralls passes)

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ pip-delete-this-directory.txt
4141

4242
# Unit test / coverage reports
4343
htmlcov/
44-
.tox/
4544
.coverage
4645
.coverage.*
4746
.cache

docs/contributing.rst

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -153,14 +153,8 @@ To also run the doctests within docstrings, run::
153153

154154
$ pytest -v --doctest-modules numcodecs
155155

156-
Tests can be run under different Python versions using tox. E.g. (assuming you have the
157-
corresponding Python interpreters installed on your system)::
158-
159-
$ tox -e py36,py37,py38,py39
160-
161156
NumCodecs currently supports Python 6-3.9, so the above command must
162-
succeed before code can be accepted into the main code base. Note that only the py39
163-
tox environment runs the doctests, i.e., doctests only need to succeed under Python 3.9.
157+
succeed before code can be accepted into the main code base.
164158

165159
All tests are automatically run via Travis (Linux) and AppVeyor (Windows) continuous
166160
integration services for every pull request. Tests must pass under both services before
@@ -175,14 +169,12 @@ Conformance can be checked by running::
175169

176170
$ flake8 --max-line-length=100 numcodecs
177171

178-
This is automatically run when invoking ``tox -e py39``.
179-
180172
Test coverage
181173
~~~~~~~~~~~~~
182174

183175
NumCodecs maintains 100% test coverage under the latest Python stable release (currently
184176
Python 3.9). Both unit tests and docstring doctests are included when computing
185-
coverage. Running ``tox -e py39`` will automatically run the test suite with coverage
177+
coverage. Running ``pytest -v --cov=numcodecs`` will automatically run the test suite with coverage
186178
and produce a coverage report. This should be 100% before code can be accepted into the
187179
main code base.
188180

@@ -206,9 +198,10 @@ included in the release notes (``docs/release.rst``).
206198

207199
The documentation can be built by running::
208200

209-
$ tox -e docs
201+
$ cd docs
202+
$ make clean; make html
210203

211-
The resulting built documentation will be available in the ``.tox/docs/tmp/html`` folder.
204+
The resulting built documentation will be available in the ``docs/_build/html`` folder.
212205

213206
Development best practices, policies and procedures
214207
---------------------------------------------------
@@ -306,10 +299,6 @@ Checkout and update the main branch::
306299
$ git checkout main
307300
$ git pull
308301

309-
Verify all tests pass on all supported Python versions, and docs build::
310-
311-
$ tox
312-
313302
Tag the version (where "X.X.X" stands for the version number, e.g., "2.2.0")::
314303

315304
$ version=X.X.X

docs/release.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,10 @@ Maintenance
4848

4949
* Add tests for all registry classes.
5050
By :user:`Josh Moore <joshmoore>`, :issue:`349`.
51-
51+
52+
* Drop tox.
53+
By :user:`John Kirkham <jakirkham>`, :issue:`384`.
54+
5255
* Update ReadTheDocs.
5356
By :user:`John Kirkham <jakirkham>`, :issue:`383`.
5457

requirements_test.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,3 @@ pytest
55
pytest-cov
66
setuptools
77
setuptools-scm
8-
tox

tox.ini

Lines changed: 0 additions & 33 deletions
This file was deleted.

0 commit comments

Comments
 (0)