@@ -21,18 +21,46 @@ or pip::
2121Frontends
2222---------
2323
24- To use PyZen you need a frontend for your environment. The Django, Flask, and
25- distutils frontends provide hooks into their respective frameworks, while the
26- standalone frontend provides a wrapper environment to run an arbitrary script
27- in.
24+ PyZen provides multiple frontends to collect and run the continuous tester.
2825
29- .. toctree ::
30- :maxdepth: 1
31-
32- frontends/django
33- frontends/flask
34- frontends/distutils
35- frontends/standalone
26+ Django
27+ ~~~~~~
28+
29+ To setup PyZen under Django add ``pyzen `` to your ``INSTALLED_APPS `` setting.
30+ The run ``manage.py zen `` to start the tester process. You can give an
31+ application label or test name using the same format as the built-in ``test ``
32+ command.
33+
34+ Flask
35+ ~~~~~
36+
37+ The Flask frontend is maintained as separate package, `Flask-Zen `_.
38+
39+ .. _Flask-Zen : http://pypi.python.org/pypi/Flask-Zen
40+
41+ Distutils
42+ ~~~~~~~~~
43+
44+ The PyZen package provides a distutils command ``zen `` that will run the test
45+ suite configured in setup.py under PyZen. Run ``setup.py zen `` to start the
46+ tester process.
47+
48+ Standalone
49+ ~~~~~~~~~~
50+
51+ The ``pyzen `` script provides a wrapper to run any test script under PyZen.
52+ Run ``pyzen yourscript.py arg1 arg2 ... `` to start the tester process. No
53+ configuration options are available at this time.
54+
55+ Options
56+ ~~~~~~~
57+
58+ ``--nocolor `` : *flag, default: False *
59+ Disable colored output.
60+
61+ ``-u ``, ``--ui `` : *default: autodetect *
62+ Force the use of a specific UI module. Available options are ``win32 ``,
63+ ``osx ``, ``linux ``, and ``none ``.
3664
3765UIs
3866---
0 commit comments