Add contributing file to detail how to build the project, run coverage tools, etc. Cleanup misc. Add coverage reporting for both HTML output and CLI output. This is ready to have Coveralls run analysis online with detailed online reporting.

Author: Robert Buck

.coveragerc

@@ -1,5 +1,5 @@
 [run]
-include=sqlalchemy_nuodb/*
+include=pynuodb/*
 
 [report]
-omit=test/*
+omit=tests/*

.gitignore

@@ -25,6 +25,7 @@ pip-log.txt
 .coverage
 .tox
 nosetests.xml
+htmlcov/
 
 # Translations
 *.mo

.travis.yml

@@ -27,6 +27,7 @@ install:
 
 script:
   - make all
+  - py.test --cov=pynuodb --cov-report term-missing
 
 after_failure:
   - cat /var/log/nuodb/agent.log

CONTRIBUTING.rst

@@ -0,0 +1,76 @@
+Development
+-----------
+
+The following sections are intended for developers.
+
+Requirements
+~~~~~~~~~~~~
+
+Developers should use virtualenv to maintain multiple side-by-side
+environments to test with. Specifically, all contributions must be
+tested with both 2.7.6 and 3.4.3 to ensure the library is syntax
+compatible between the two versions.
+
+Dependencies
+~~~~~~~~~~~~
+
+Here was my basic setup on Mac OS X:
+
+    | virtualenv --python=/usr/bin/python2.7 ~/.venv/pynuodb
+    | source ~/.venv/pynuodb/bin/activate
+    | pip install mock
+    | pip install nose
+    | pip install pytest
+    | pip install coverage
+
+There are some commonly used libraries with this:
+
+    | pip install sqlalchemy
+    | pip install sqlalchemy-nuodb
+
+Or simply:
+
+    | pip install -r requirements.txt
+
+Then once those are setup...
+
+Developer Testing
+~~~~~~~~~~~~~~~~~
+
+My basic means of testing has been:
+
+    | source ~/.venv/pynuodb/bin/activate
+    | cd <project directory>
+    | py.test
+
+First and foremost, painful py.test less, it captures STDOUT and will not
+display your log messages. To disable this behavior and enable sane logging
+the following option is suggested:
+
+    | --capture=no
+
+To stop on first failure you could augment that with the pdb option:
+
+    | py.test --pdb
+
+To run a specific test you could do something like this:
+
+    | py.test -k "SomeTest and test_something"
+
+Or any combination of the above, if you like.
+
+To gather coverage information you can run the following command:
+
+    | py.test --cov=pynuodb --cov-report html --cov-report term-missing
+
+Developer Installation
+~~~~~~~~~~~~~~~~~~~~~~
+
+With pip installed, you can install this project via:
+
+    | pip install -e .
+
+Release
+-------
+
+Maintain the list of changes per release in CHANGES.rst. Also note the known defects.

Makefile

@@ -36,7 +36,7 @@ install:
 
 test:
 	pip install -r test_requirements.txt
-	py.test tests
+	py.test --cov=pynuodb --cov-report html --cov-report term-missing
 
 deploy:
 	python setup.py register

tests/nuodb_cursor_test.py

@@ -33,8 +33,6 @@ def test_cursor_rowcount_select(self):
     def test_insufficient_parameters(self):
         con = self._connect()
         cursor = con.cursor()
-        #       cursor.execute("SELECT ? FROM DUAL")
-        #       cursor.execute("SELECT ? FROM DUAL", [0])
 
         try:
             cursor.execute("SELECT ?, ? FROM DUAL", [1])