Merge branch 'release/0.7.1' into develop

.coveragerc

@@ -0,0 +1,9 @@
+[run]
+source = drmaa
+omit =
+    */python?.?/*
+    */lib-python/?.?/*.py
+    */lib_pypy/_*.py
+    */site-packages/ordereddict.py
+    */site-packages/nose/*
+    */unittest2/*

.gitignore

@@ -1,4 +1,11 @@
-*.py[cod]
+# Compiled python
+*.pyc
+*.pyo
+__pycache__
+
+
+.DS_Store
+.coverage
 
 # C extensions
 *.so

.travis.yml

@@ -2,22 +2,30 @@ language: python
 python:
   - 2.6
   - 2.7
-  - 3.2
+  - 3.3
 
 notifications:
   email: false
 
 # Install stuff
+virtualenv:
+  system_site_packages: true
 before_install:
   - travis/install_sge.sh
   - export GRID_MAP_REDIS_PORT=12345
   - export SGE_ROOT=/var/lib/gridengine
   - export SGE_CELL=default
   - export DRMAA_LIBRARY_PATH=/usr/lib/libdrmaa.so.1.0
 install:
+  - pip install python-coveralls --use-mirrors
+  - pip install nose-cov --use-mirrors
   - python setup.py install
 
 # Run test
 script:
-  - nosetests -d -v
+  - nosetests -d -v --with-cov --cov drmaa --cov-config .coveragerc --logging-level=DEBUG
+
+# Calculate coverage
+after_success:
+  - coveralls --config_file .coveragerc
 

MANIFEST.in

@@ -2,3 +2,4 @@ include license.txt
 include *.rst
 recursive-include examples *
 recursive-include test *
+recursive-include docs *

README.rst

@@ -1,10 +1,61 @@
-drmaa-python
+DRMAA Python
 ------------
 
-
-.. image:: https://travis-ci.org/dan-blanchard/drmaa-python.png
-   :target: https://travis-ci.org/dan-blanchard/drmaa-python
+.. image:: https://travis-ci.org/drmaa-python/drmaa-python.png
+   :target: https://travis-ci.org/drmaa-python/drmaa-python
    :alt: Travis build status
 
-DRMAA bindings for Python. Now Python 3 compatible.
+.. image:: https://coveralls.io/repos/drmaa-python/drmaa-python/badge.png
+  :target: https://coveralls.io/r/drmaa-python/drmaa-python
+  :alt: Test coverage
+
+.. image:: https://pypip.in/d/drmaa/badge.png
+   :target: https://crate.io/packages/drmaa
+   :alt: PyPI downloads
+
+.. image:: https://pypip.in/v/drmaa/badge.png
+   :target: https://crate.io/packages/drmaa
+   :alt: Latest version on PyPI
+
+`Distributed Resource Management Application API <http://en.wikipedia.org/wiki/DRMAA>`__
+(DRMAA) bindings for Python. For more information
+`read the docs <http://drmaa-python.readthedocs.org>`__.
+
+Requirements
+~~~~~~~~~~~~
+
+-  Python 2.6+
+-  A DRMAA-compatible cluster (e.g., Grid Engine)
+
+License
+~~~~~~~
+
+-  BSD (3 Clause)
+
+Changelog
+~~~~~~~~~
+
+-  v0.7.1
+
+   -  Add `Read The Docs documentation <http://drmaa-python.readthedocs.org>`__
+   -  Add ``const`` module identifiers back into package namespace
+   -  Remove ``b`` prefixes from strings inserted into error messages.
+
+-  v0.7.0
 
+   -  String attribute issues with Python 3 have all been resolved, and now each
+      function that takes a string can handle unicode strings, and returns
+      unicode strings.
+   -  All code has been updated to use future imports for ``unicode_literals``
+      and ``print_function``, so we're effectively writing Python 3 code now.
+   -  PEP8 compliance changes all over the place, except those that would break
+      names required by underlying C DRMAA library.
+   -  Now automatically run unit tests of Travis-CI with SGE, and all tests pass
+      for Python 2.6, 2.7, and 3.3.  SGE is installed using scripts I describe
+      in `this gist <https://gist.github.com/dan-blanchard/6586533>`__.
+   -  Unit tests are now in a top-level directory instead of a sub-directory
+      under the drmaa package.
+   -  There is now a `session.py` module that contains most of the code that was
+      in ``__init__.py`` before, and ``__init__`` just imports things and sets
+      ``__all__`` and ``__version__``, as is typically recommended now.
+   -  Drops support for Python 2.5.

docs/Makefile

@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/DRMAAPython.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/DRMAAPython.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/DRMAAPython"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/DRMAAPython"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."