From f9c6b1f5905b4b7e9feb193bc599f937599acb5a Mon Sep 17 00:00:00 2001 From: Abhas Bhattacharya Date: Thu, 21 Jan 2016 21:09:48 +0530 Subject: [PATCH] docs: Move ptw instruction to "How to use" section [ci skip] --- readme.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index 3755c90..2d08a76 100644 --- a/readme.md +++ b/readme.md @@ -15,6 +15,10 @@ Pytest Status GUI ### How to use? `py.test --show_status_gui` +**Recommended** : Use with [pytest-watch][ptw_gh_link] using `ptw -- --show_status_gui` + +pytest-watch re-runs py.test on any change to your code + ### What is it? pytest_status_gui is only a pytest plugin, which @@ -23,9 +27,7 @@ pytest_status_gui is only a pytest plugin, which - updates the db with test run status (step running currently, for eg "Collecting Tests") and some details of the steps (like no. of tests passed) as it becomes available to the plugin. - The GUI on the other hand periodically polls data (using js timer with 1 sec interval) from the db and updates itself. -It is **recommended for use with [pytest-watch][ptw_gh_link]** which re-runs py.test on any change to your code. Run using `ptw -- --show_status_gui` - -The result is that you get some nifty **test status windows that update as you keep editing files**. It is inspired from **[pytddmon](http://pytddmon.org/?page_id=33)**. +The result is that you get some nifty **test status windows that update as you keep editing files**. It is inspired from **[pytddmon][pytddmon_video_link]**, which is more minimailistic and supports only nosetests. [Travis_SVG_Link]: https://travis-ci.org/bendtherules/pytest_gui_status.svg?branch=master @@ -38,3 +40,5 @@ The result is that you get some nifty **test status windows that update as you k [ptw_gh_link]: https://github.com/joeyespo/pytest-watch [demo_gif_link]:http://i.imgur.com/ReGMVpu.gif +[pytddmon_video_link]:http://pytddmon.org/?page_id=33 +