From 85f33a83e713ddc7019885c05858dfc7df6a2256 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 1 Mar 2015 10:25:35 -0500 Subject: Added section describing standalone usage and example. --- README | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README b/README index c249394..9a21198 100644 --- a/README +++ b/README @@ -45,6 +45,31 @@ See the `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 `_, +reported in `jsonpickle #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 -------------- -- cgit v1.2.1