summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorRobert Collins <robertc@robertcollins.net>2012-10-27 22:27:55 +1300
committerRobert Collins <robertc@robertcollins.net>2012-10-27 22:27:55 +1300
commitf8e93227207a1eddef02cb306651074172f64188 (patch)
tree1130670ee05bf24efccc0ce81f8bba6bb8fb5052 /README.rst
parent87a05a447f982e4ddc954fb2c72fa59637c4bd58 (diff)
downloadpython-test-extras-f8e93227207a1eddef02cb306651074172f64188.tar.gz
Initial extraction of code from testtools.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst49
1 files changed, 49 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..cb5c4d8
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,49 @@
+======
+extras
+======
+
+extras is a set of extensions to the Python standard library, originally
+written to make the code within testtools cleaner, but now split out for
+general use outside of a testing context.
+
+
+Documentation
+-------------
+
+pydoc extras is your friend.
+
+
+Licensing
+---------
+
+This project is distributed under the MIT license and copyright is owned by
+the extras authors. See LICENSE for details.
+
+
+Required Dependencies
+---------------------
+
+ * Python 2.6+ or 3.0+
+
+
+Bug reports and patches
+-----------------------
+
+Please report bugs using github issues at <https://github.com/testing-cabal/extras>.
+Patches can also be submitted via github. You can mail the authors directly
+via the mailing list testtools-dev@lists.launchpad.net. (Note that Launchpad
+discards email from unknown addresses - be sure to sign up for a Launchpad
+account before mailing the list, or your mail will be silently discarded).
+
+
+History
+-------
+
+extras used to be testtools.helpers, and was factored out when folk wanted to
+use it separately.
+
+
+Thanks
+------
+
+ * Martin Pool