Sync setup and README with default

This commit is contained in:
Nick Coghlan 2016-01-12 21:08:23 +10:00
parent 6820fad049
commit fc66300a90
4 changed files with 58 additions and 10 deletions

View file

@ -1,3 +1,3 @@
include *.py *.txt *.rst
include *.py *.txt *.rst *.md
recursive-include docs *.rst *.py make.bat Makefile

40
README.md Normal file
View file

@ -0,0 +1,40 @@
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.
[![Codeship Status for ncoghlan/contextlib2](https://codeship.com/projects/884e9500-3d1a-0133-3eb0-1abe7f570a4c/status?branch=default)](https://codeship.com/projects/102388)
[![codecov.io](https://codecov.io/bitbucket/ncoghlan/contextlib2/coverage.svg?branch=default)](https://codecov.io/bitbucket/ncoghlan/contextlib2?branch=default)

View file

@ -1,3 +0,0 @@
contextlib2 is a backport of the standard library's contextlib module to earlier Python versions.
It also serves as a real world proving ground for possible future enhancements to the standard library version.

View file

@ -1,9 +1,9 @@
#!/usr/bin/env python
from distutils.core import setup
# Technically, unittest2 is a dependency to run the tests on 2.6 and 3.1
# This file ignores that, since I don't want to depend on distribute
# or setuptools just to get "tests_require" support
# Technically, unittest2 is a dependency to run the tests on 2.7
# This file ignores that, since I don't want to depend on
# setuptools just to get "tests_require" support
setup(
name='contextlib2',
@ -11,8 +11,19 @@ setup(
py_modules=['contextlib2'],
license='PSF License',
description='Backports and enhancements for the contextlib module',
long_description=open('README.txt').read(),
long_description=open('README.md').read(),
author='Nick Coghlan',
author_email='ncoghlan@gmail.com',
url='http://contextlib2.readthedocs.org'
)
url='http://contextlib2.readthedocs.org',
classifiers=[
'Development Status :: 5 - Production/Stable',
'License :: OSI Approved :: Python Software Foundation License',
# These are the Python versions tested, it may work on others
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
],
)