docs: Move ptw instruction to "How to use" section [ci skip]

This commit is contained in:
2016-01-21 21:09:48 +05:30
parent 0fe0ff741b
commit f9c6b1f590
+7 -3
View File
@@ -15,6 +15,10 @@ Pytest Status GUI
### How to use? ### How to use?
`py.test --show_status_gui` `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? ### What is it?
pytest_status_gui is only a pytest plugin, which 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. - 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. - 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][pytddmon_video_link]**, which is more minimailistic and supports only nosetests.
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)**.
[Travis_SVG_Link]: https://travis-ci.org/bendtherules/pytest_gui_status.svg?branch=master [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 [ptw_gh_link]: https://github.com/joeyespo/pytest-watch
[demo_gif_link]:http://i.imgur.com/ReGMVpu.gif [demo_gif_link]:http://i.imgur.com/ReGMVpu.gif
[pytddmon_video_link]:http://pytddmon.org/?page_id=33