Skip to content

Commit

Permalink
Remove tox, recommend uv
Browse files Browse the repository at this point in the history
tox has been popular in times when it was easier to run a full Python
test matrix on your workstation, for example supported by `pyenv`,
compared to provisioning and maintaining it on a Jenkins CI runner.

Nowadays, it became so easy to run the full-version test matrix on
GitHub Actions (GHA), so `tox` became obsolete in such environments
that heavily use GHA. Now that recent advancements added `uv` to the
table, sandbox environments don't need to feel ousted.
  • Loading branch information
amotl committed Jan 24, 2025
1 parent a2aae9b commit b44ca89
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 27 deletions.
21 changes: 9 additions & 12 deletions DEVELOP.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ CrateDB Python developer guide
Setup
=====

Optionally install Python package and project manager ``uv``,
Optionally install Python package and project manager `uv`_,
in order to significantly speed up the package installation::

{apt,brew,pip,zypper} install uv
Expand Down Expand Up @@ -67,16 +67,11 @@ To inspect the whole list of test cases, run::

bin/test --list-tests

You can run the tests against multiple Python interpreters with `tox`_::

tox

To do this, you will need the respective Python interpreter versions available
on your ``$PATH``.

To run against a single interpreter, you can also invoke::

tox -e py37
The CI setup on GitHub Actions (GHA) provides a full test matrix covering
relevant Python versions. You can invoke the software tests against a specific
Python interpreter or multiple `Python versions`_ on your workstation using
`uv`_, by supplying the ``--python`` command-line option, or by defining the
`UV_PYTHON`_ environment variable prior to invoking ``source bootstrap.sh``.

*Note*: Before running the tests, make sure to stop all CrateDB instances which
are listening on the default CrateDB transport port to avoid side effects with
Expand Down Expand Up @@ -168,12 +163,14 @@ nothing special you need to do to get the live docs to update.
.. _@crate/docs: https://github.com/orgs/crate/teams/docs
.. _buildout: https://pypi.python.org/pypi/zc.buildout
.. _PyPI: https://pypi.python.org/pypi
.. _Python versions: https://docs.astral.sh/uv/concepts/python-versions/
.. _Read the Docs: http://readthedocs.org
.. _ReStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx-doc.org/
.. _tests/assets/pki/*.pem: https://github.com/crate/crate-python/tree/main/tests/assets/pki
.. _tox: http://testrun.org/tox/latest/
.. _twine: https://pypi.python.org/pypi/twine
.. _useful command-line options for zope-testrunner: https://pypi.org/project/zope.testrunner/#some-useful-command-line-options-to-get-you-started
.. _uv: https://docs.astral.sh/uv/
.. _UV_PYTHON: https://docs.astral.sh/uv/configuration/environment/#uv_python
.. _versions hosted on ReadTheDocs: https://readthedocs.org/projects/crate-python/versions/
.. _zope.testrunner: https://pypi.org/project/zope.testrunner/
1 change: 0 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ def read(path):
"poethepoet<0.33",
"ruff<0.10",
"stopit>=1.1.2,<2",
"tox>=3,<5",
"pytz",
"zc.customdoctests>=1.0.1,<2",
"zope.testing>=4,<6",
Expand Down
14 changes: 0 additions & 14 deletions tox.ini

This file was deleted.

0 comments on commit b44ca89

Please sign in to comment.