README.rst
1=========
2testtools
3=========
4
5testtools is a set of extensions to the Python standard library's unit testing
6framework.
7
8These extensions have been derived from years of experience with unit testing
9in Python and come from many different sources.
10
11
12Documentation
13-------------
14
15If you would like to learn more about testtools, consult our documentation in
16the 'doc/' directory. You might like to start at 'doc/overview.rst' or
17'doc/for-test-authors.rst'.
18
19
20Licensing
21---------
22
23This project is distributed under the MIT license and copyright is owned by
24Jonathan M. Lange and the testtools authors. See LICENSE for details.
25
26Some code in 'testtools/run.py' is taken from Python's unittest module, and is
27copyright Steve Purcell and the Python Software Foundation, it is distributed
28under the same license as Python, see LICENSE for details.
29
30
31Supported platforms
32-------------------
33
34 * Python 3.5+ or PyPy3
35
36If you would like to use testtools for earlier Pythons, consult the compatibility docs:
37
38 * https://testtools.readthedocs.io/en/latest/overview.html#cross-python-compatibility
39
40testtools probably works on all OSes that Python works on, but is most heavily
41tested on Linux and macOS.
42
43
44Optional Dependencies
45---------------------
46
47If you would like to use our Twisted support, then you will need Twisted.
48
49If you want to use ``fixtures`` then you can either install fixtures (e.g. from
50https://launchpad.net/python-fixtures or https://pypi.python.org/pypi/fixtures)
51or alternatively just make sure your fixture objects obey the same protocol.
52
53
54Bug reports and patches
55-----------------------
56
57Please report bugs using Launchpad at <https://bugs.launchpad.net/testtools>.
58Patches should be submitted as GitHub pull requests, or mailed to the authors.
59See ``doc/hacking.rst`` for more details.
60
61There's no mailing list for this project yet, however the testing-in-python
62mailing list may be a useful resource:
63
64 * Address: testing-in-python@lists.idyll.org
65 * Subscription link: http://lists.idyll.org/listinfo/testing-in-python
66
67
68History
69-------
70
71testtools used to be called 'pyunit3k'. The name was changed to avoid
72conflating the library with the Python 3.0 release (commonly referred to as
73'py3k').
74
75
76Thanks
77------
78
79 * Canonical Ltd
80 * Bazaar
81 * Twisted Matrix Labs
82 * Robert Collins
83 * Andrew Bennetts
84 * Benjamin Peterson
85 * Jamu Kakar
86 * James Westby
87 * Martin [gz]
88 * Michael Hudson-Doyle
89 * Aaron Bentley
90 * Christian Kampka
91 * Gavin Panella
92 * Martin Pool
93 * Julia Varlamova
94 * ClusterHQ Ltd
95 * Tristan Seligmann
96 * Jonathan Jacobs
97 * Jelmer Vernooij
98 * Hugo van Kemenade
99 * Zane Bitter
100