Merge branch 'docs_to_add' into dev

This commit is contained in:
2016-01-21 20:49:59 +05:30
2 changed files with 23 additions and 16 deletions
+14 -13
View File
@@ -1,19 +1,19 @@
Todo Todo
------ ------
1. Test on Appveyor - python 2.x builds don't stop - use tox 1. test template path available after install
1.1. Use tox for wrapping around py.test 2. test option --show_status_gui available
2. Release on pypi 3. add details of --show_status_gui in addoption
3. Add well-explained readme 4. Release on pypi
3.1. Add cli doc for --show_status_gui 5. Add well-explained readme
4. use logging.debug / log file for more prints 6. Allow config for template
5. Tests with setup/teardown/class when needed 7. use logging.debug / log file for more prints
6. Faster Tests with timeout, if required by extra api to params 8. Tests with setup/teardown/class when needed
7. Allow config for template 9. Faster Tests with timeout, if required by extra api to params
8. Add gui tests 10. Add real gui tests
9. Use config.pluginmanager.hasplugin('plugin_name') when needed 11. Use config.pluginmanager.hasplugin('plugin_name') when needed
10. Give icon to gui + preferably dynamic with status 12. Give icon to gui + preferably dynamic with status
Done Done
@@ -41,8 +41,9 @@ Think
2. Think about popen stdouts 2. Think about popen stdouts
Discarded Discarded / Later
---------- ----------
1. Show "redis not connected" in gui itself instead of console 1. Show "redis not connected" in gui itself instead of console
2. In plugin, set attributes in chunk using pipeline, using `with` 2. In plugin, set attributes in chunk using pipeline, using `with`
3. Test on Appveyor - python 2.x builds don't stop
+9 -3
View File
@@ -1,12 +1,15 @@
Pytest Status GUI Pytest Status GUI
================== ==================
### => Always on GUI for showing test status (with pytest)
| Travis CI | Appveyor (skipped 2.x) | Circle CI | | Travis CI | Appveyor (skipped 2.x) | Circle CI |
| ------------- | ------------- | --------- | | ------------- | ------------- | --------- |
| [![Travis Build][Travis_SVG_Link]][Travis_Project_Page] | [![Appveyor Build][Appveyor_SVG_Link]][Appveyor_Project_Page] | [![CircleCI Build][CircleCI_SVG_Link]][CircleCI_Project_Page] | | [![Travis Build][Travis_SVG_Link]][Travis_Project_Page] | [![Appveyor Build][Appveyor_SVG_Link]][Appveyor_Project_Page] | [![CircleCI Build][CircleCI_SVG_Link]][CircleCI_Project_Page] |
### => Always on GUI for showing test status (with pytest)
![In action][demo_gif_link]
`pip install pytest_gui_status` `pip install pytest_gui_status`
### How to use? ### How to use?
@@ -20,7 +23,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** which re-runs py.test on any change to your code. Run using `ptw -- --show_status_gui` 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](http://pytddmon.org/?page_id=33)**.
@@ -32,3 +35,6 @@ The result is that you get some nifty **test status windows that update as you k
[Appveyor_Project_Page]:https://ci.appveyor.com/project/bendtherules/pytest-gui-status [Appveyor_Project_Page]:https://ci.appveyor.com/project/bendtherules/pytest-gui-status
[CircleCI_Project_Page]:https://circleci.com/gh/bendtherules/pytest_gui_status [CircleCI_Project_Page]:https://circleci.com/gh/bendtherules/pytest_gui_status
[Travis_Project_Page]: https://travis-ci.org/bendtherules/pytest_gui_status [Travis_Project_Page]: https://travis-ci.org/bendtherules/pytest_gui_status
[ptw_gh_link]: https://github.com/joeyespo/pytest-watch
[demo_gif_link]:http://i.imgur.com/ReGMVpu.gif