Skip to content

Commit

Permalink
Add badges to readme and fix PyPI description.
Browse files Browse the repository at this point in the history
The included docs use sphinx extensions now, which don't work on PyPI.

The badges revealed that we don't have coveralls setup.
  • Loading branch information
jamadden committed Oct 25, 2018
1 parent 6f51773 commit b99ca37
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 23 deletions.
25 changes: 13 additions & 12 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,37 +1,38 @@
Changes
=======
=========
Changes
=========

4.2.0 (unreleased)
--------------------
==================

- Add support for Python 3.5, 3.6, and 3.7.

- Drop support for Python 2.6 and 3.3.


4.1.0 (2014-12-27)
--------------------
==================

- Add support for PyPy (PyPy3 blocked on PyPy3-compatible ``zodbpickle``).

- Add support for Python 3.4.


4.0.0 (2014-12-20)
--------------------
==================

- Add support for testing on Travis.


4.0.0a2 (2013-02-25)
--------------------
====================

- Ensure that the ``SimpleKeyReference`` implementation (used for testing)
also implements rich comparison properly.


4.0.0a1 (2013-02-22)
--------------------
====================

- Add support for Python 3.3.

Expand All @@ -45,30 +46,30 @@ Changes


3.6.4 (2011-11-30)
------------------
==================

- Fix tests broken by removal of ``zope.testing`` from test dependencies:
avoid the ``ZODB3`` module that needs it.

3.6.3 (2011-11-29)
------------------
==================

- Prefer the standard libraries doctest module to the one from ``zope.testing``.

3.6.2 (2009-09-15)
------------------
==================

- Make the tests pass with ZODB3.9, which changed the repr() of the persistent
classes.

3.6.1 (2009-02-01)
------------------
==================

- Load keyreferences, pickled by old zope.app.keyreference even
if its not installed anymore (so don't break if one updates a
project that don't directly depends on zope.app.keyreference).

3.6.0 (2009-01-31)
------------------
==================

- Rename ``zope.app.keyreference`` to ``zope.keyreference``.
26 changes: 20 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,27 @@
``zope.keyreference``
=====================
===================
zope.keyreference
===================

.. image:: https://img.shields.io/pypi/v/zope.keyreference.svg
:target: https://pypi.org/project/zope.keyreference/
:alt: Latest Version

.. image:: https://img.shields.io/pypi/pyversions/zope.keyreference.svg
:target: https://pypi.org/project/zope.keyreference/
:alt: Supported Python versions

.. image:: https://travis-ci.org/zopefoundation/zope.keyreference.svg?branch=master
:target: https://travis-ci.org/zopefoundation/zope.keyreference
:target: https://travis-ci.org/zopefoundation/zope.keyreference
:alt: Build Status

.. image:: https://coveralls.io/repos/github/zopefoundation/zope.keyreference/badge.svg
:target: https://coveralls.io/github/zopefoundation/zope.keyreference
:alt: Code Coverage

.. image:: https://readthedocs.org/projects/zopekeyreference/badge/?version=latest
:target: http://zopekeyreference.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
:target: https://zopekeyreference.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

Object references that support stable comparison and hashes.

Documentation can be found at http://zopekeyreference.readthedocs.io
Documentation can be found at https://zopekeyreference.readthedocs.io
5 changes: 0 additions & 5 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,6 @@ def read(*rnames):
long_description=(
read("README.rst")
+ "\n\n"
+ "Detailed Documentation\n"
+ "----------------------\n"
+ "\n\n"
+ read("src", "zope", "keyreference", "persistent.txt")
+ "\n\n"
+ read("CHANGES.rst")
),
keywords="zope3 key reference persistent",
Expand Down

0 comments on commit b99ca37

Please sign in to comment.