lib/testtools/README

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