Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nejucomo.ticket7.add-dependency-instructions-for-testing #1

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,9 @@ https://tahoe-lafs.org/trac/pyutil
tests and benchmarks
====================

Testing requires these dependencies: ``twisted``, ``setuptools_trial``,
and ``simplejson``.

To run tests: ``python ./setup.py trial -s pyutil.test.current``.

You can also run the tests with the standard pyunit test runner instead of
Expand All @@ -125,6 +128,20 @@ pyutil.test import test_cache; test_cache.slow_bench()'``
(The "-O" is important when benchmarking, since cache has extensive
self-tests that are optimized out when -O is included.)

testing with virtualenv
-----------------------

You can install all testing tools and test-time dependencies in a local
`virtualenv` which avoids interference with user- or system-wide python
packages. Here's an example of this process (command output omitted):

.. code:: bash

$ git clone 'https://github.com/zooko/pyutil'
$ cd pyutil/
$ virtualenv ./venv
$ ./venv/bin/pip install twisted setuptools_trial simplejson
$ ./venv/bin/python ./setup.py trial -s pyutil.test

LICENCE
=======
Expand Down