Skip to content

Commit fba1e7a

Browse files
committed
docs: add version compatibility notice
1 parent 0cb3e1a commit fba1e7a

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

README.rst

+21-1
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,34 @@ Coveralls for Python
3434
.. image:: https://img.shields.io/pypi/implementation/coveralls.svg?style=flat-square&label=Python%20Implementations
3535
:target: https://pypi.org/project/coveralls/
3636

37-
`coveralls.io`_ is a service for publishing your coverage stats online. This package provides seamless integration with `coverage.py`_ (and thus ``pytest``, ``nosetests``, etc...) in your Python projects::
37+
`coveralls.io`_ is a service for publishing your coverage stats online. This
38+
package provides seamless integration with `coverage.py`_ (and thus ``pytest``,
39+
``nosetests``, etc...) in your Python projects::
3840

3941
pip install coveralls
4042
coverage run --source=mypkg setup.py test
4143
coveralls
4244

4345
For more information and usage instructions, see our `documentation`_.
4446

47+
Version Compatibility
48+
---------------------
49+
50+
As of version 2.0, we have dropped support for end-of-life'd versions of Python
51+
and particularly old version of coverage. Support for non-EOL'd environments is
52+
provided on a best-effort basis and will generally be removed once they make
53+
maintenance too difficult.
54+
55+
If you're running on an outdated environment with a new enough package manager
56+
to support version checks (see `the PyPA docs`_), then installing the latest
57+
compatible version should do the trick. If you're even more outdated than that,
58+
please pin to ``coveralls<2``.
59+
60+
If you're in an outdated environment and experiencing an issue, feel free to
61+
open a ticket -- but please mention your environment! I'm willing to backport
62+
fixes to the 1.x branch if need be.
63+
4564
.. _coveralls.io: https://coveralls.io/
4665
.. _coverage.py: https://coverage.readthedocs.io/en/latest/
4766
.. _documentation: http://coveralls-python.readthedocs.io/en/latest/
67+
.. _the PyPA docs: https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires

setup.py

+1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
'coveralls = coveralls.cli:main',
3333
],
3434
},
35+
python_requires='>= 3.5',
3536
install_requires=[
3637
'coverage>=4.1,<6.0',
3738
'docopt>=0.6.1',

0 commit comments

Comments
 (0)