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.6+ or 3.0+
  35
  36 If you would like to use testtools for earlier Python's, please use testtools
  37 0.9.15.
  38
  39
  40 Optional Dependencies
  41 ---------------------
  42
  43 If you would like to use our undocumented, unsupported Twisted support, then
  44 you will need Twisted.
  45
  46 If you want to use ``fixtures`` then you can either install fixtures (e.g. from
  47 https://launchpad.net/python-fixtures or http://pypi.python.org/pypi/fixtures)
  48 or alternatively just make sure your fixture objects obey the same protocol.
  49
  50
  51 Bug reports and patches
  52 -----------------------
  53
  54 Please report bugs using Launchpad at <https://bugs.launchpad.net/testtools>.
  55 Patches can also be submitted via Launchpad, or mailed to the author.  You can
  56 mail the author directly at jml@mumak.net.
  57
  58 There's no mailing list for this project yet, however the testing-in-python
  59 mailing list may be a useful resource:
  60
  61  * Address: testing-in-python@lists.idyll.org
  62  * Subscription link: http://lists.idyll.org/listinfo/testing-in-python
  63
  64
  65 History
  66 -------
  67
  68 testtools used to be called 'pyunit3k'.  The name was changed to avoid
  69 conflating the library with the Python 3.0 release (commonly referred to as
  70 'py3k').
  71
  72
  73 Thanks
  74 ------
  75
  76  * Canonical Ltd
  77  * Bazaar
  78  * Twisted Matrix Labs
  79  * Robert Collins
  80  * Andrew Bennetts
  81  * Benjamin Peterson
  82  * Jamu Kakar
  83  * James Westby
  84  * Martin [gz]
  85  * Michael Hudson-Doyle
  86  * Aaron Bentley
  87  * Christian Kampka
  88  * Gavin Panella
  89  * Martin Pool