Skip to content

Commit e344c8f

Browse files
coderangercoderanger
committed
Adding basic documenation.
1 parent b369bd8 commit e344c8f

File tree

6 files changed

+141
-26
lines changed

6 files changed

+141
-26
lines changed

‎README

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
1-
=====
21
PyZen
32
=====
43

5-
PyZen is a work-a-like to Ruby's ZenTest framework. It will run in the
6-
background and re-run your test suite when a change is detected.
7-
8-
Django
9-
======
4+
PyZen is a continuous test runner for paranoid developers. As long as the
5+
script is running, it will monitor for changes in your code and re-run your
6+
test suite when needed. There are frontends for multiple frameworks as well
7+
as several notification UIs.
108

11-
Configuration
12-
-------------
13-
Just add ``pyzen`` to your ``INSTALLED_APPS``.
9+
For further documentation see http://packages.python.org/PyZen
1410

15-
Usage
16-
-----
17-
PyZen adds a new manage.py command ``zen``. To close the tester use
18-
ctrl+c.
11+
Installation
12+
------------
1913

14+
PyZen can be installed from PyPI using easy_install::
15+
16+
$ easy_install PyZen
17+
18+
or pip::
19+
20+
$ pip install PyZen
21+

‎docs/frontends/distutils.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Distutils Frontend
2+
==================
3+
4+
The PyZen package provides a distutils command ``zen`` that will run the
5+
test suite configured in setup.py under PyZen.
6+
7+
Usage
8+
-----
9+
10+
Run ``setup.py zen`` to start the tester process.
11+
12+
Options
13+
~~~~~~~
14+
15+
``--nocolor`` : *flag, default: False*
16+
Disable colored output.
17+
18+
``-u``, ``--ui`` : *default: autodetect*
19+
Force the use of a specific UI module. Available options are ``win32``,
20+
``osx``, ``linux``, and ``none``.

‎docs/frontends/django.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Django Frontend
2+
===============
3+
4+
PyZen itself can be setup as a Django application, and provides a management
5+
command for running the project's tests under PyZen.
6+
7+
Configuration
8+
-------------
9+
10+
Just add ``pyzen`` to your ``INSTALLED_APPS`` setting.
11+
12+
Usage
13+
-----
14+
15+
Run ``manage.py zen`` to start the tester process. You can give an application
16+
label or test name using the same format as the built-in ``test`` command.
17+
18+
Options
19+
~~~~~~~
20+
21+
``--nocolor`` : *flag, default: False*
22+
Disable colored output.
23+
24+
``-u``, ``--ui`` : *default: autodetect*
25+
Force the use of a specific UI module. Available options are ``win32``,
26+
``osx``, ``linux``, and ``none``.

‎docs/frontends/flask.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Flask Frontend
2+
==============
3+
4+
The Flask frontend is maintained as separate package, `Flask-Zen`_.
5+
6+
.. _Flask-Zen: http://pypi.python.org/pypi/Flask-Zen

‎docs/frontends/standalone.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Standalone Frontend
2+
===================
3+
4+
The ``pyzen`` script provides a wrapper to run any test script under PyZen.
5+
6+
Usage
7+
-----
8+
9+
Run ``pyzen yourscript.py arg1 arg2 ...`` to start the tester process. No
10+
configuration options are available at this time.

‎docs/index.rst

Lines changed: 64 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,71 @@
1-
.. PyZen documentation master file, created by
2-
sphinx-quickstart on Sat Aug 14 18:14:46 2010.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
1+
PyZen
2+
=====
53

6-
Welcome to PyZen's documentation!
7-
=================================
4+
PyZen is a continuous test runner for paranoid developers. As long as the
5+
script is running, it will monitor for changes in your code and re-run your
6+
test suite when needed. There are frontends for multiple frameworks as well
7+
as several notification UIs.
88

9-
Contents:
9+
Installation
10+
------------
11+
12+
PyZen can be installed from PyPI using easy_install::
13+
14+
$ easy_install PyZen
15+
16+
or pip::
17+
18+
$ pip install PyZen
19+
20+
21+
Frontends
22+
---------
23+
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.
1028

1129
.. toctree::
12-
:maxdepth: 2
30+
:maxdepth: 1
31+
32+
frontends/django
33+
frontends/flask
34+
frontends/distutils
35+
frontends/standalone
36+
37+
UIs
38+
---
39+
40+
PyZen provides a UI to indicate the current test status after each run, even
41+
if the console is in the background. In addition to the three
42+
platform-specific interfaces, the ``none`` interface will disable this
43+
display. See the frontend documentation for details, but most frontends offer
44+
a ``--ui`` option to override the autodetection.
45+
46+
Win32
47+
~~~~~
48+
49+
The default UI on Windows is a systray icon indicating the current test status
50+
and balloon notifications after each run. This UI is tested on Windows XP and
51+
higher, though it may work with Windows 2000.
52+
53+
OS X
54+
~~~~
55+
56+
The default UI on OS X uses Growl via AppleScript. A Growl notification is
57+
posted after each test run.
58+
59+
Linux
60+
~~~~~
1361

14-
Indices and tables
15-
==================
62+
The default UI on Linux uses libnotify via the pynotify library. This is
63+
installed by default on current versions of Ubuntu. If pynotify is not found,
64+
the interface will be disabled.
1665

17-
* :ref:`genindex`
18-
* :ref:`modindex`
19-
* :ref:`search`
66+
Test Runner
67+
-----------
2068

69+
By default PyZen enhances the test output with color. It is known to work on
70+
both Windows and \*nix systems. Most frontends have a ``--nocolor`` option to
71+
disable it if needed.

0 commit comments

Comments
 (0)