From 0f80e9013a048cb8e68d109a2bc7f1291093af13 Mon Sep 17 00:00:00 2001 From: Lockefox Date: Sun, 13 May 2018 19:36:47 -0700 Subject: [PATCH] copying index.rst -> README.rst --- README.rst | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 673eded..553c038 100644 --- a/README.rst +++ b/README.rst @@ -6,7 +6,22 @@ ProsperTestUtils |Build Status| |Coverage Status| |PyPI Badge| |Docs| |Gitter| -Collection of test helpers for Prosper python projects +Helper libraries for test coverage and general maintenance of services. Making test coverage easier across Prosper projects! + +Quickstart +========== + +.. code-block:: python + + setup( + ... + tests_require=[ + 'prospertestutils', + ] + ) + +ProsperTestUtils is suggested as a ``tests_require`` install. Though there are some general use utilities, this library is not meant for production use. +