Browse files

Tidy up docs, add requirements.txt

  • Loading branch information...
1 parent d9b51dd commit 49a77de09edb8eb12356585756937cb55d91cc61 @wapcaplet wapcaplet committed Mar 15, 2012
Showing with 41 additions and 15 deletions.
  1. +34 −5 docs/index.rst
  2. +7 −0 requirements.txt
  3. +0 −10 tests/README.txt
@@ -58,14 +58,14 @@ You can obtain Grinder Webtest by downloading a official release from the
`downloads page`_, then extracting it to a location on your disk. In later
versions of Jython_, you can install like this::
- jython install
+ $ jython install
Alternatively, you can just build and run your tests directly in the source
directory (it'll probably work better that way).
If you want a copy of the latest development version, clone it from Github_::
- git clone git://
+ $ git clone git://
The only dependency aside from Grinder is Jython_. Due to some limitations in
earlier versions of Grinder, this module was designed to work with Jython 2.2.1.
@@ -76,7 +76,6 @@ please let us know whether or not it works.
.. _downloads page:
.. _Jython:
-.. _Github:
@@ -122,17 +121,47 @@ pathnames for your environment. On Linux, it might look something like this::
Save the changes to ````. You can run the tests in a single agent
process like so::
- jython agent
+ $ jython agent
Or, if you would like to use the console, ensure your ````
has ``grinder.useConsole=true``, then run the console::
- jython console
+ $ jython console
Then start agents in separate terminals. Refer to the `Grinder docs`_ for more
information about the console, agents, and properties.
+Please report bugs and feature requests to the `issues page`_.
.. _Grinder docs:
+.. _issues page:
+If you'd like to work on developing grinder-webtest, fork the project from
+Github_ and clone your fork. You may also want to set up a virtual environment
+for installing any Python dependencies (pythonbrew_ is nice), activate it, then
+ $ pip install -r requirements.txt
+Some unit tests are included in the ``tests`` directory, which you can run using
+pytest_ like this::
+ $ py.test
+This will also generate an HTML-formatted coverage report in ``htmlcov``. The
+tests should work using regular Python, so you don't need to muck about with
+Jython for this.
+If you develop any cool new features or fix any bugs, please submit a `pull
+.. _Github:
+.. _pythonbrew:
+.. _pytest:
@@ -0,0 +1,7 @@
@@ -1,10 +0,0 @@
-This directory contains unit tests for Grinder Webtest, written using nose_.
-Run ``nosetests`` from the main ``grinder-webtest`` project directory to
-execute them.
-The ``data`` directory contains sample ``.webtest`` files for testing
-.. _nose:

0 comments on commit 49a77de

Please sign in to comment.