Skip to content

Commit 62cc35b

Browse files
committed
Add changelog and other useful info to README
1 parent 6a11deb commit 62cc35b

1 file changed

Lines changed: 56 additions & 5 deletions

File tree

README.rst

Lines changed: 56 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,61 @@
1-
drmaa-python
1+
DRMAA Python
22
------------
33

4-
5-
.. image:: https://travis-ci.org/dan-blanchard/drmaa-python.png
6-
:target: https://travis-ci.org/dan-blanchard/drmaa-python
4+
.. image:: https://travis-ci.org/drmaa-python/drmaa-python.png
5+
:target: https://travis-ci.org/drmaa-python/drmaa-python
76
:alt: Travis build status
87

9-
DRMAA bindings for Python. Now Python 3 compatible.
8+
.. image:: https://coveralls.io/repos/drmaa-python/drmaa-python/badge.png
9+
:target: https://coveralls.io/r/drmaa-python/drmaa-python
10+
:alt: Test coverage
11+
12+
.. image:: https://pypip.in/d/drmaa-python/badge.png
13+
:target: https://crate.io/packages/drmaa-python
14+
:alt: PyPI downloads
15+
16+
.. image:: https://pypip.in/v/drmaa-python/badge.png
17+
:target: https://crate.io/packages/drmaa-python
18+
:alt: Latest version on PyPI
19+
20+
`Distributed Resource Management Application API <http://en.wikipedia.org/wiki/DRMAA>`__
21+
(DRMAA) bindings for Python. For more information
22+
`read the docs <http://drmaa-python.readthedocs.org>`__.
23+
24+
Requirements
25+
~~~~~~~~~~~~
26+
27+
- Python 2.6+
28+
- A DRMAA-compatible cluster (e.g., Grid Engine)
29+
30+
License
31+
~~~~~~~
32+
33+
- BSD (3 Clause)
34+
35+
Changelog
36+
~~~~~~~~~
37+
38+
- v0.7.1
39+
40+
- Add `Read The Docs documentation <http://drmaa-python.readthedocs.org>`__
41+
- Add ``const`` module identifiers back into package namespace
42+
- Remove ``b`` prefixes from strings inserted into error messages.
43+
44+
- v0.7.0
1045

46+
- String attribute issues with Python 3 have all been resolved, and now each
47+
function that takes a string can handle unicode strings, and returns
48+
unicode strings.
49+
- All code has been updated to use future imports for ``unicode_literals``
50+
and ``print_function``, so we're effectively writing Python 3 code now.
51+
- PEP8 compliance changes all over the place, except those that would break
52+
names required by underlying C DRMAA library.
53+
- Now automatically run unit tests of Travis-CI with SGE, and all tests pass
54+
for Python 2.6, 2.7, and 3.3. SGE is installed using scripts I describe
55+
in `this gist <https://gist.github.com/dan-blanchard/6586533>`__.
56+
- Unit tests are now in a top-level directory instead of a sub-directory
57+
under the drmaa package.
58+
- There is now a `session.py` module that contains most of the code that was
59+
in ``__init__.py`` before, and ``__init__`` just imports things and sets
60+
``__all__`` and ``__version__``, as is typically recommended now.
61+
- Drops support for Python 2.5.

0 commit comments

Comments
 (0)