mirror of
https://github.com/jazzband/contextlib2.git
synced 2026-03-16 21:50:24 +00:00
Revert README to ReST formatting for PyPI
This commit is contained in:
parent
4469999858
commit
20cdf6eda5
5 changed files with 46 additions and 42 deletions
|
|
@ -1,3 +1,3 @@
|
|||
include *.py *.txt *.rst *.md
|
||||
include *.py *.txt *.rst
|
||||
recursive-include docs *.rst *.py make.bat Makefile
|
||||
|
||||
|
|
|
|||
2
NEWS.rst
2
NEWS.rst
|
|
@ -7,6 +7,8 @@ Release History
|
|||
* Python 2.6 compatilibity restored (although 2.6 is still missing from the
|
||||
current CI configuration)
|
||||
|
||||
* README converted back to reStructured Text formatting
|
||||
|
||||
0.5.0 (2016-01-12)
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
|
|
|||
40
README.md
40
README.md
|
|
@ -1,40 +0,0 @@
|
|||
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
|
||||
|
||||
Continuous integration
|
||||
----------------------
|
||||
|
||||
CI is set up in Codeship to run against PRs and commits.
|
||||
|
||||
[](https://codeship.com/projects/102388)
|
||||
[](https://codecov.io/bitbucket/ncoghlan/contextlib2?branch=default)
|
||||
42
README.rst
Normal file
42
README.rst
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
.. 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
|
||||
2
setup.py
2
setup.py
|
|
@ -11,7 +11,7 @@ setup(
|
|||
py_modules=['contextlib2'],
|
||||
license='PSF License',
|
||||
description='Backports and enhancements for the contextlib module',
|
||||
long_description=open('README.md').read(),
|
||||
long_description=open('README.rst').read(),
|
||||
author='Nick Coghlan',
|
||||
author_email='ncoghlan@gmail.com',
|
||||
url='http://contextlib2.readthedocs.org',
|
||||
|
|
|
|||
Loading…
Reference in a new issue