Added a development page and modified doctest to automatically

jkeyes · jkeyes · commit 862b7d2049ca · 2012-03-28T10:25:04.000+01:00
run the doctests of all modules in the intercom package.
diff --git a/bin/doctest b/bin/doctest
@@ -5,16 +5,20 @@ import os
 import site
 import sys
 
-# at least one module must be specified
-if len(sys.argv) == 1:
-    print "No module specified."
-
 # calculate the working directory
 sdir = os.path.abspath(__file__)
 wd = os.path.dirname(os.path.dirname(sdir))
 site.addsitedir(wd)
 
+# at least one module must be specified
+if len(sys.argv) == 1:
+    glob_pattern = os.path.join(wd, 'intercom', '*.py')
+    import glob
+    modules = glob.glob(glob_pattern)
+else:
+    modules = sys.argv[1:]
+
 # for each module
-for module_path in sys.argv[1:]:
+for module_path in modules:
     print "Testing " + module_path
     doctest.testfile(module_path, module_relative=False)
diff --git a/docs/development.rst b/docs/development.rst
@@ -0,0 +1,73 @@
+Development
+===========
+
+Running the tests
+-----------------
+
+Run all of the (nose) tests:
+
+::
+
+    nosetests --with-coverage --cover-package=intercom tests
+
+Run the unit tests:
+
+::
+
+    nosetests tests -e integration
+
+Run the integration tests (using the dummy `app_id` and `api_key`):
+
+::
+
+    nosetests tests -e unit
+
+Doctests
+--------
+
+Run all of the doctests:
+
+::
+
+    ./bin/doctest
+
+Run the doctests in a specific module:
+
+::
+
+    ./bin/doctest intercom/user.py
+
+Code coverage
+-------------
+
+Generate a code coverage report:
+
+::
+
+    nosetests --with-coverage --cover-package=intercom tests
+    Name                      Stmts   Miss  Cover   Missing
+    -------------------------------------------------------
+    intercom                     21      0   100%   
+    intercom.impression          25      0   100%   
+    intercom.intercom            85      0   100%   
+    intercom.message_thread      64      0   100%   
+    intercom.user               125      0   100%   
+    -------------------------------------------------------
+    TOTAL                       320      0   100%   
+    -------------------------------------------------------
+
+Pylint
+------
+
+Generate a pylint report for a specific module:
+
+::
+
+    pylint --rcfile=pylint.conf intercom/user.py
+
+Generate a full pylint report:
+
+::
+
+    pylint --rcfile=pylint.conf intercom
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,11 +3,12 @@ python-intercom
 ===============
 
 .. toctree::
-   :hidden:
+    :hidden:
 
-   api/modules
-   installation
-   changelog
+    installation
+    api/modules
+    changelog
+    development
 
 Installation
 ============
@@ -133,6 +134,12 @@ Reply on a Message Thread
             thread_id=123,
             body="Not much either :(")
 
+Development
+===========
+
+Our :doc:`development` page has detailed instructions on how to run our
+tests, and to produce coverage and pylint reports.
+
 Changelog
 =========
 
