summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitignore3
-rw-r--r--README.md13
-rw-r--r--test-requirements.txt4
-rw-r--r--tox.ini13
4 files changed, 32 insertions, 1 deletions
diff --git a/.gitignore b/.gitignore
index 1a26c03a..f6f85969 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,3 +9,6 @@ cover/
/doc/_build
nbproject
*.sublime-workspace
+
+/*egg-info
+/.tox
diff --git a/README.md b/README.md
index 0b5f5a2a..fcf74c3d 100644
--- a/README.md
+++ b/README.md
@@ -13,8 +13,9 @@ The object database implementation is optimized for handling large quantities of
- Tested with nose 1.3.0
* Mock by Michael Foord used for tests
- Tested with 1.0.1
+* Coverage - used for tests coverage
-The list of dependencies are listed in /requirements.txt. The installer takes care of installing them for you though.
+The list of dependencies are listed in /requirements.txt and /test-requirements.txt. The installer takes care of installing them for you though.
### INSTALL
@@ -32,6 +33,16 @@ A distribution package can be obtained for manual installation at:
http://pypi.python.org/pypi/GitPython
+### RUNNING TESTS
+
+The easiest way to run test is by using [tox](https://pypi.python.org/pypi/tox) a wrapper around virtualenv. It will take care of setting up environnements with the proper dependencies installed and execute test commands. To install it simply:
+
+ pip install tox
+
+Then run:
+
+ tox
+
### DEVELOPMENT STATUS
[![Build Status](https://travis-ci.org/gitpython-developers/GitPython.svg?branch=0.3)](https://travis-ci.org/gitpython-developers/GitPython)
diff --git a/test-requirements.txt b/test-requirements.txt
new file mode 100644
index 00000000..6da60814
--- /dev/null
+++ b/test-requirements.txt
@@ -0,0 +1,4 @@
+# Remember to update README.md
+coverage
+nose
+mock
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 00000000..a89b1348
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,13 @@
+[tox]
+envlist = py26,py27
+
+[testenv]
+commands = nosetests
+deps = -r{toxinidir}/requirements.txt
+ -r{toxinidir}/test-requirements.txt
+
+[testenv:cover]
+commands = nosetests --with-coverage
+
+[testenv:venv]
+commands = {posargs}