contextlib2/README.rst
2016-04-17 19:30:39 +10:00

51 lines
1.5 KiB
ReStructuredText

.. image:: https://readthedocs.org/projects/contextlib2/badge/?version=latest
:target: https://contextlib2.readthedocs.org/
:alt: Latest Docs
.. image:: https://img.shields.io/travis/ncoghlan/contextlib2/master.svg
:target: http://travis-ci.org/ncoghlan/contextlib2
.. image:: https://landscape.io/github/ncoghlan/contextlib2/master/landscape.svg
:target: https://landscape.io/github/ncoghlan/contextlib2/
.. todo: set up Coveralls
contextlib2 is a backport of the `standard library's contextlib
module <https://docs.python.org/3.5/library/contextlib.html>`_ to
earlier Python versions.
It also serves as a real world proving ground for possible future
enhancements to the standard library version.
Development
-----------
contextlib2 currently has no dependencies.
Local testing is currently just a matter of running ``python test_contextlib2.py``.
You can test against multiple versions of Python with
`tox <https://tox.testrun.org/>`_::
pip install tox
tox
Versions currently tested in both tox and Travis CI are:
* CPython 2.6
* CPython 2.7
* CPython 3.4
* CPython 3.5
* CPython 3.6 (CPython development branch)
* PyPy
tox also has a PyPy3 configuration, but it is not configured in Travis
due to a
`known incompatibility <https://bitbucket.org/pypy/pypy/issues/1903>`_.
To install several of the relevant runtimes on Fedora 23::
sudo dnf install python python3 pypy pypy3
sudo dnf copr enable -y mstuchli/Python3.5
sudo dnf install python35-python3