contextlib2/README.rst
2016-01-13 22:43:32 +10:00

42 lines
No EOL
1.3 KiB
ReStructuredText

.. image:: https://readthedocs.org/projects/contextlib2/badge/?version=latest
:target: https://contextlib2.readthedocs.org/
:alt: Latest Docs
.. image:: https://codeship.com/projects/884e9500-3d1a-0133-3eb0-1abe7f570a4c/status?branch=default
:target: https://codeship.com/projects/102388
.. image:: https://codecov.io/bitbucket/ncoghlan/contextlib2/coverage.svg?branch=default
:target: https://codecov.io/bitbucket/ncoghlan/contextlib2?branch=default
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 <http://tox.testrun.org/>`_::
pip install tox
tox
Versions currently tested in tox are:
* CPython 2.7 (also tested in Codeship)
* CPython 3.4 (also tested in Codeship)
* CPython 3.5
* PyPy
* PyPy3
To install all 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