Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/trunk' into lots-more-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
glyph committed Dec 20, 2023
2 parents cc87fda + 8ba31f8 commit 2939c22
Show file tree
Hide file tree
Showing 11 changed files with 27 additions and 28 deletions.
14 changes: 6 additions & 8 deletions .github/workflows/cicd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -194,26 +194,24 @@ jobs:
matrix:
os: ["ubuntu-latest"]
python-version: ["3.7", "3.9", "3.10", "3.11"]
twisted-version: ["21.2", "22.1", "current"]
twisted-version: ["21.2", "22.1", "23.8", "23.10"]
tox-prefix: ["coverage"]
optional: [false]
include:
- os: "ubuntu-latest"
python-version: "pypy-3.8"
twisted-version: "current"
# We need at least one PyPy environment with coverage enabled, but
# it's quite slow so we'll disable it everywhere else.
twisted-version: "23.8"
tox-prefix: "test"
optional: false
- os: "ubuntu-latest"
python-version: "pypy-3.9"
twisted-version: "current"
tox-prefix: "coverage"
twisted-version: "23.8"
tox-prefix: "test"
optional: false
# Test Python 3.12 but allow it to fail
- os: "ubuntu-latest"
python-version: "3.12.0-alpha.7"
twisted-version: "current"
python-version: "3.12.0"
twisted-version: "23.8"
tox-prefix: "test"
optional: true

Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Klein is an open source project that welcomes contributions of all kinds coming
Getting started
===============

Here is a list of shell commands that will install the dependencies of Klein, run the test suite with Python 3.8 and the current version of Twisted, compile the documentation, and check for coding style issues with flake8.
Here is a list of shell commands that will install the dependencies of Klein, run the test suite with Python 3.8 and Twisted 23.8, compile the documentation, and check for coding style issues with flake8.

.. code-block:: shell
pip install --user tox
tox -e py38-twcurrent
tox -e py312-tw238
tox -e docs
tox -e flake8
Expand All @@ -45,7 +45,7 @@ Code
Klein uses `Twisted Trial <https://docs.twisted.org/en/stable/api/twisted.trial.html>`_ and `tox <https://tox.readthedocs.io/en/latest/>`_ for its tests.
The command to run the full test suite is ``tox`` with no arguments.
This will run tests against several versions of Python and Twisted, which can be time-consuming.
To run tests against only one or a few versions, pass a ``-e`` argument with an environment from the envlist in ``tox.ini``: for example, ``tox -e py38-twcurrent`` will run tests with Python 3.8 and the current released version of Twisted.
To run tests against only one or a few versions, pass a ``-e`` argument with an environment from the envlist in ``tox.ini``: for example, ``tox -e py38-tw238`` will run tests with Python 3.8 and Twisted 23.8.
To run only one or a few specific tests in the suite, add a filename or fully-qualified Python path to the end of the test invocation: for example, ``tox klein.test.test_app.KleinTestCase.test_foo`` will run only the ``test_foo()`` method of the ``KleinTestCase`` class in ``klein/test/test_app.py``.
These two test shortcuts can be combined to give you a quick feedback cycle, but make sure to check on the full test suite from time to time to make sure changes haven't had unexpected side effects.
- Show us your code changes through pull requests sent to `Klein's GitHub repo <https://github.com/twisted/klein>`_.
Expand Down
2 changes: 1 addition & 1 deletion requirements/black.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
black==23.7.0
black==23.11.0
5 changes: 2 additions & 3 deletions requirements/mypy.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
cryptography==41.0.1
mypy==1.5.1
mypy-zope==1.0.1
mypy==1.7.1
mypy-zope==1.0.2
types-click==7.1.8
2 changes: 1 addition & 1 deletion requirements/packaging.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
readme-renderer==40.0
readme-renderer==42.0
twine==4.0.2
2 changes: 1 addition & 1 deletion requirements/pre-commit.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
pre-commit==3.4.0
pre-commit==3.5.0
2 changes: 1 addition & 1 deletion requirements/pyupgrade.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
pyupgrade==3.10.1
pyupgrade==3.15.0
2 changes: 1 addition & 1 deletion requirements/release.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
click==8.1.7
GitPython==3.1.34
GitPython==3.1.40
incremental[scripts]==22.10.0
twine==4.0.2
4 changes: 2 additions & 2 deletions requirements/sphinx.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
Sphinx==7.2.5
sphinx-rtd-theme==2.0.0rc2
Sphinx==7.2.6
sphinx-rtd-theme==2.0.0
6 changes: 3 additions & 3 deletions requirements/tox-pin-base.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ characteristic==14.3.0
constantly==15.1.0
hyperlink==21.0.0
incremental==22.10.0
PyHamcrest==2.0.4
PyHamcrest==2.1.0
six==1.16.0
Tubes==0.2.1
Werkzeug==2.3.7; python_version > '3.7'
Werkzeug==3.0.1; python_version > '3.7'
Werkzeug==2.1.2; python_version <= '3.7'
zope.interface==6.0
zope.interface==6.1
10 changes: 6 additions & 4 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

envlist =
lint, mypy
coverage-py{37,38,39,310,311,py3}-tw{212,221,current,trunk}
coverage-py{37,38,39,310,311,312,py3}-tw{212,221,238,trunk}
coverage_combine
coverage_report
docs, docs-linkcheck
Expand Down Expand Up @@ -120,7 +120,7 @@ commands = coverage combine
basepython={[default]basepython}
deps = coverage
depends =
coverage-py{37,38,39,310,311,py3}-tw{212,221,current,trunk}
coverage-py{37,38,39,310,311,py3}-tw{212,221,2310,trunk}


[testenv:coverage_report]
Expand All @@ -129,7 +129,9 @@ description = generate coverage report

depends =
coverage-py{37,38,39,310,311,py3}-tw{1,2}{0,1,2,3,4,5,6,7,8,9}{0,1,2,3,4,5,6,7,8,9}
coverage-py{37,38,39,310,311,py3}-tw{current,trunk}
coverage-py{37,38,39,310,311,py3}-tw{2310,trunk}
coverage-py{37,38,39,310,311,312,py3}-tw{1,2}{0,1,2,3,4,5,6,7,8,9}{0,1,2,3,4,5,6,7,8,9}
coverage-py{37,38,39,310,311,312,py3}-tw{2310,trunk}
coverage_combine

basepython = {[default]basepython}
Expand Down Expand Up @@ -231,7 +233,7 @@ description = check for potential packaging problems

depends =
coverage-py{37,38,39,310,311,py3}-tw{1,2}{0,1,2,3,4,5,6,7,8,9}{0,1,2,3,4,5,6,7,8,9}
coverage-py{37,38,39,310,311,py3}-tw{current,trunk}
coverage-py{37,38,39,310,311,py3}-tw{2310,trunk}

basepython = {[default]basepython}

Expand Down

0 comments on commit 2939c22

Please sign in to comment.