summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorColin Watson <cjwatson@canonical.com>2022-04-23 19:05:18 +0100
committerJelmer Vernooij <jelmer@jelmer.uk>2022-07-01 19:30:00 +0100
commit4cbf5cfc2c39571389f9f0da7f7a14f53a4d554e (patch)
tree0b92268fa5d204a7b0bc8d1497a94268a568fd11
parent621553dd73ff076c00aa80a1afcf87d4ab415981 (diff)
downloadtesttools-4cbf5cfc2c39571389f9f0da7f7a14f53a4d554e.tar.gz
Provide a ``testtools[twisted]`` extra
This documents dependencies needed for `testtools.twistedsupport`. At the moment this is just `Twisted`, but it generally seems a good idea to put this sort of thing in an official extra rather than having it be documented ad-hoc.
-rw-r--r--.github/workflows/test.yml4
-rw-r--r--NEWS3
-rw-r--r--README.rst3
-rw-r--r--doc/twisted-support.rst3
-rw-r--r--readthedocs-requirements.txt3
-rw-r--r--setup.cfg2
-rw-r--r--tox.ini2
7 files changed, 13 insertions, 7 deletions
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 67bcba9..6793d7d 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -34,8 +34,8 @@ jobs:
run: |
python3 -m pip install -U pip
python3 -m pip install -U wheel setuptools
- python3 -m pip install sphinx Twisted
- python3 -m pip install ".[test]"
+ python3 -m pip install sphinx
+ python3 -m pip install ".[test,twisted]"
- name: Tests
run: |
diff --git a/NEWS b/NEWS
index 91068c2..933fbc3 100644
--- a/NEWS
+++ b/NEWS
@@ -18,6 +18,9 @@ Improvements
* Distutils integration is deprecated and will be removed in the next major
version.
+* Provide a ``testtools[twisted]`` extra documenting dependencies needed for
+ ``testtools.twistedsupport``.
+
2.5.0
~~~~~
diff --git a/README.rst b/README.rst
index 3a377fe..3041333 100644
--- a/README.rst
+++ b/README.rst
@@ -47,7 +47,8 @@ tested on Linux and macOS.
Optional Dependencies
---------------------
-If you would like to use our Twisted support, then you will need Twisted.
+If you would like to use our Twisted support, then you will need the
+``testtools[twisted]`` extra.
If you want to use ``fixtures`` then you can either install fixtures (e.g. from
https://launchpad.net/python-fixtures or https://pypi.python.org/pypi/fixtures)
diff --git a/doc/twisted-support.rst b/doc/twisted-support.rst
index 3ec6d0f..6243592 100644
--- a/doc/twisted-support.rst
+++ b/doc/twisted-support.rst
@@ -3,7 +3,8 @@
Twisted support
===============
-testtools provides support for testing Twisted code.
+testtools provides support for testing Twisted code. Install the
+``testtools[twisted]`` extra to use this.
Matching Deferreds
diff --git a/readthedocs-requirements.txt b/readthedocs-requirements.txt
index e44982f..80bdb5c 100644
--- a/readthedocs-requirements.txt
+++ b/readthedocs-requirements.txt
@@ -6,5 +6,4 @@
# that it knows exactly what to install in order to render the full
# documentation.
-testtools[test]
-Twisted
+testtools[test,twisted]
diff --git a/setup.cfg b/setup.cfg
index 2909ef2..d88deed 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -28,6 +28,8 @@ classifier =
test =
testscenarios
testresources
+twisted =
+ Twisted
[files]
packages = testtools
diff --git a/tox.ini b/tox.ini
index 3ddd88b..b28a030 100644
--- a/tox.ini
+++ b/tox.ini
@@ -6,8 +6,8 @@ minversion = 1.6
usedevelop = True
deps =
sphinx
- Twisted
extras =
test
+ twisted
commands =
python -W once -m testtools.run testtools.tests.test_suite