From 5db6b368fc02b7ed8646b0da28dad444ba66bd74 Mon Sep 17 00:00:00 2001 From: staticdev Date: Fri, 19 Feb 2021 18:28:11 +0100 Subject: [PATCH] Add badges --- README.rst | 41 ++++++++++++++++++++++++++++++++++------- 1 file changed, 34 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index ba2d563e..8403072b 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,38 @@ github4.py ========== +|PyPI| |Python Version| |License| + +|Read the Docs| |Tests| |Codecov| + +|pre-commit| |Black| + +.. |PyPI| image:: https://img.shields.io/pypi/v/github4.py.svg + :target: https://pypi.org/project/github4.py/ + :alt: PyPI +.. |Python Version| image:: https://img.shields.io/pypi/pyversions/github4.py + :target: https://pypi.org/project/github4.py + :alt: Python Version +.. |License| image:: https://img.shields.io/pypi/l/github4.py + :target: https://opensource.org/licenses/MIT + :alt: License +.. |Read the Docs| image:: https://img.shields.io/readthedocs/github4/latest.svg?label=Read%20the%20Docs + :target: https://github4.readthedocs.io/ + :alt: Read the documentation at https://github4.readthedocs.io/ +.. |Tests| image:: https://github.com/staticdev/github4.py/workflows/Tests/badge.svg + :target: https://github.com/staticdev/github4.py/actions?workflow=Tests + :alt: Tests +.. |Codecov| image:: https://codecov.io/gh/staticdev/github4.py/branch/master/graph/badge.svg + :target: https://codecov.io/gh/staticdev/github4.py + :alt: Codecov +.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white + :target: https://github.com/pre-commit/pre-commit + :alt: pre-commit +.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black + :alt: Black + + github4.py an actively developed wrapper around the GitHub API that forks github3.py_. Note: This library currently works with Python 3.7+ or pypy3. For older versions, please use github3.py_ version 1.3.0. @@ -17,9 +49,11 @@ You can install *github4.py* via pip_ from PyPI_: Dependencies ------------ +- dateutil_ - requests_ - uritemplate_ +.. _dateutil: https://github.com/dateutil/dateutil .. _requests: https://github.com/kennethreitz/requests .. _uritemplate: https://github.com/sigmavirus24/uritemplate @@ -41,13 +75,6 @@ Issues If you encounter any problems, please `file an issue`_ along with a detailed description. -Examples --------- - -See the docs_ for more examples. - -.. _docs: https://github3.readthedocs.io/en/latest/index.html#more-examples - Credits -------