Merge branch 'hashar-tox' into 0.3

Byron · Byron · commit 0f09906d27af · 2014-11-14T16:16:38.000+01:00
Make tox available, see gitpython-developers#179 [skip ci]
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,6 @@ cover/
 /doc/_build
 nbproject
 *.sublime-workspace
+
+/*egg-info
+/.tox
diff --git a/README.md b/README.md
@@ -13,6 +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 and /test-requirements.txt. The installer takes care of installing them for you though.
 
 ### INSTALL
 
@@ -22,15 +25,27 @@ The object database implementation is optimized for handling large quantities of
 If you have downloaded the source code:
 
     python setup.py install
-    
-or if you want to obtain a copy more easily: 
+
+or if you want to obtain a copy from the Pypi repository:
 
     pip install gitpython
-    
+
+Both commands will install the required package dependencies.
+
 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
+
 ### SOURCE
 
 GitPython's git repo is available on GitHub, which can be browsed at [github](https://github.com/gitpython-developers/GitPython) and cloned like that:
diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,2 @@
 GitPython
-gitdb>=0.6.0
+gitdb>=0.6.0
diff --git a/setup.py b/setup.py
@@ -16,6 +16,8 @@
 VERSION = v.readline().strip()
 v.close()
 
+with open('requirements.txt') as reqs_file:
+    requirements = reqs_file.read().splitlines()
 
 class build_py(_build_py):
     def run(self):
diff --git a/test-requirements.txt b/test-requirements.txt
@@ -0,0 +1,4 @@
+coverage
+flake8
+nose
+mock
diff --git a/tox.ini b/tox.ini
@@ -0,0 +1,20 @@
+[tox]
+envlist = py26,py27,flake8
+
+[testenv]
+commands = nosetests
+deps = -r{toxinidir}/requirements.txt
+       -r{toxinidir}/test-requirements.txt
+
+[testenv:cover]
+commands = nosetests --with-coverage
+
+[testenv:flake8]
+commands = flake8
+
+[testenv:venv]
+commands = {posargs}
+
+[flake8]
+#show-source = True
+exclude = .tox,.venv,build,dist,doc,git/ext/

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`GitPython`
`2`		`-gitdb>=0.6.0`
	`2`	`+gitdb>=0.6.0`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +coverage
 +flake8
 +nose
 +mock