summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2015-03-01 10:25:35 -0500
committerJason R. Coombs <jaraco@jaraco.com>2015-03-01 10:25:35 -0500
commit85f33a83e713ddc7019885c05858dfc7df6a2256 (patch)
tree3968f409bd89b04328f947c5e5a1da394ffb8eb8
parent5d911074ba86c7aefa9c1a39741ca8268a7c4d11 (diff)
downloadpytest-runner-85f33a83e713ddc7019885c05858dfc7df6a2256.tar.gz
Added section describing standalone usage and example.
-rw-r--r--README25
1 files changed, 25 insertions, 0 deletions
diff --git a/README b/README
index c249394..9a21198 100644
--- a/README
+++ b/README
@@ -45,6 +45,31 @@ See the `jaraco.collections
<https://bitbucket.org/jaraco/jaraco.collections/>`_ project
for real-world usage.
+Standalone Example
+------------------
+
+Although ``pytest-runner`` is typically used to add pytest test
+runner support to maintained packages, ``pytest-runner`` may
+also be used to create standalone tests. Consider `this example
+failure <https://gist.github.com/jaraco/d979a558bc0bf2194c23>`_,
+reported in `jsonpickle #117
+<https://github.com/jsonpickle/jsonpickle/issues/117>`_.
+
+That single file may be cloned or downloaded and simply run on
+any system with Python and Setuptools. It will download the
+specified dependencies and run the tests. Afterward, the the
+cloned directory can be removed and with it all trace of
+invoking the test. No other dependencies are needed and no
+system configuration is altered.
+
+Then, anyone trying to replicate the failure can do so easily
+and with all the power of pytest (rewritten assertions,
+rich comparisons, interactive debugging, extensibility through
+plugins, etc).
+
+As a result, the communication barrier for describing and
+replicating failures is made almost trivially low.
+
Considerations
--------------