- packahe config cleanup and README beautification

zopefoundation · Apr 4, 2019 · 7d7347d · 7d7347d
1 parent b0ed399
commit 7d7347d
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 2 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -3,6 +3,10 @@ Change Log
 
 2.0b4 (2019-04-04)
 ------------------
+- added ``project_urls`` to the setup so PyPI shows more relevant links
+
+- added project badges to the README, which will show on the GitHub front page
+
 - Fix ZMI Templates and add ZMI icons for Zope 4
   (`#36 <https://github.com/zopefoundation/Products.PluggableAuthService/pull/36>`_)
 

diff --git a/README.rst b/README.rst
@@ -1,5 +1,23 @@
-Products.PluggableAuthService README
-====================================
+Products.PluggableAuthService
+=============================
+
+.. image:: https://api.travis-ci.org/zopefoundation/Products.PluggableAuthService.svg?branch=master
+   :target: https://travis-ci.com/zopefoundation/Products.PluggableAuthService
+
+.. image:: https://coveralls.io/repos/github/zopefoundation/Products.PluggableAuthService/badge.svg
+   :target: https://coveralls.io/github/zopefoundation/Products.PluggableAuthService
+
+.. image:: https://readthedocs.org/projects/productspluggableauthservice/badge/?version=latest
+   :target: https://productspluggableauthservice.readthedocs.io/
+   :alt: Documentation Status
+
+.. image:: https://img.shields.io/pypi/v/Products.PluggableAuthService.svg
+   :target: https://pypi.org/project/Products.PluggableAuthService/
+   :alt: Latest stable release on PyPI
+
+.. image:: https://img.shields.io/pypi/pyversions/Products.PluggableAuthService.svg
+   :target: https://pypi.org/project/Products.PluggableAuthService/
+   :alt: Stable release supported Python versions`
 
 This product defines a fully-pluggable user folder, intended for
 use in all Zope sites.

diff --git a/setup.py b/setup.py
@@ -45,6 +45,14 @@ def _package_doc(name):
       author="Zope Foundation and Contributors",
       author_email="zope-cmf@zope.org",
       url="https://github.com/zopefoundation/Products.PluggableAuthService",
+      url='https://productspluggableauthservice.readthedocs.io',
+      project_urls={
+          'Documentation': 'https://productspluggableauthservice.readthedocs.io',
+          'Issue Tracker': ('https://github.com/zopefoundation'
+                            '/Products.PluggableAuthService/issues'),
+          'Sources': ('https://github.com/zopefoundation/'
+                      'Products.PluggableAuthService'),
+      },
       license="ZPL 2.1 (http://www.zope.org/Resources/License/ZPL-2.1)",
       packages=find_packages(),
       include_package_data=True,