From a7402dc081f89708997b14eb95f3140a8c328d4b Mon Sep 17 00:00:00 2001 From: "Jason M. Gates" Date: Tue, 9 Jan 2024 15:44:24 -0700 Subject: [PATCH] docs: Add more badges Add additional badges to capture things like contributions, the conda-forge release channel, etc. --- README.md | 10 +++++++++- doc/source/index.rst | 26 +++++++++++++++++++++++--- 2 files changed, 32 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b6a002e..5b1dff5 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,23 @@ [![codecov](https://codecov.io/gh/sandialabs/reverse_argparse/branch/master/graph/badge.svg?token=FmDStZ6FVR)](https://codecov.io/gh/sandialabs/reverse_argparse) [![Continuous Integration](https://github.com/sandialabs/reverse_argparse/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/sandialabs/reverse_argparse/actions/workflows/continuous-integration.yml) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md) +[![GitHub contributors](https://img.shields.io/github/contributors/sandialabs/reverse_argparse.svg)](https://github.com/sandialabs/reverse_argparse/graphs/contributors) [![Documentation Status](https://readthedocs.org/projects/reverse-argparse/badge/?version=latest)](https://reverse-argparse.readthedocs.io/en/latest/?badge=latest) +[![Anaconda-Server Badge](https://anaconda.org/conda-forge/reverse-argparse/badges/license.svg)](LICENSE.md) [![Linting: Pylint](https://img.shields.io/badge/Linting-Pylint-yellowgreen)](https://github.com/pylint-dev/pylint) +[![Merged PRs](https://img.shields.io/github/issues-pr-closed-raw/sandialabs/reverse_argparse.svg?label=merged+PRs)](https://github.com/sandialabs/reverse_argparse/pulls?q=is:pr+is:merged) [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7632/badge)](https://bestpractices.coreinfrastructure.org/projects/7632) +![Anaconda-Server Badge](https://anaconda.org/conda-forge/reverse-argparse/badges/platforms.svg) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit) [![pre-commit.ci Status](https://results.pre-commit.ci/badge/github/sandialabs/reverse_argparse/master.svg)](https://results.pre-commit.ci/latest/github/sandialabs/reverse_argparse/master) -[![PyPI Version](https://badge.fury.io/py/reverse-argparse.svg)](https://badge.fury.io/py/reverse-argparse) ![Python Version](https://img.shields.io/badge/Python-3.8|3.9|3.10|3.11|3.12-blue.svg) [![Security: Bandit](https://img.shields.io/badge/Security-Bandit-yellow.svg)](https://github.com/PyCQA/bandit) +| Release Channel | Version | Downloads | +|-----------------|---------|-----------| +| PyPI | [![PyPI Version](https://badge.fury.io/py/reverse-argparse.svg)](https://badge.fury.io/py/reverse-argparse) | ![PyPI - Downloads](https://img.shields.io/pypi/dm/reverse-argparse) | +| conda-forge | [![Anaconda-Server Badge](https://anaconda.org/conda-forge/reverse-argparse/badges/version.svg)](https://anaconda.org/conda-forge/reverse-argparse) | ![Anaconda-Server Badge](https://anaconda.org/conda-forge/reverse-argparse/badges/downloads.svg) | + # reverse_argparse Whereas [`argparse`][argparse] is concerned with taking a bunch of command line diff --git a/doc/source/index.rst b/doc/source/index.rst index 01adc9e..86c2bb3 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -14,12 +14,15 @@ reverse_argparse |codecov| |Continuous Integration| |Contributor Covenant| +|GitHub Contributors| |Documentation Status| +|License| |Linting: Pylint| +|Merged PRs| |OpenSSF Best Practices| +|Platforms| |pre-commit| |pre-commit.ci Status| -|PyPI Version| |Python Version| |Security: Bandit| @@ -31,22 +34,39 @@ reverse_argparse :target: https://github.com/sandialabs/reverse_argparse/actions/workflows/continuous-integration.yml .. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg :target: https://github.com/sandialabs/reverse_argparse/blob/master/CODE_OF_CONDUCT.md +.. |GitHub Contributors| image:: https://img.shields.io/github/contributors/sandialabs/reverse_argparse.svg + :target: https://github.com/sandialabs/reverse_argparse/graphs/contributors .. |Documentation Status| image:: https://readthedocs.org/projects/reverse-argparse/badge/?version=latest :target: https://reverse-argparse.readthedocs.io/en/latest/?badge=latest +.. |License| image:: https://anaconda.org/conda-forge/reverse-argparse/badges/license.svg + :target: https://github.com/sandialabs/reverse_argparse/blob/master/LICENSE.md .. |Linting: Pylint| image:: https://img.shields.io/badge/Linting-Pylint-yellowgreen :target: https://github.com/pylint-dev/pylint +.. |Merged PRs| image:: https://img.shields.io/github/issues-pr-closed-raw/sandialabs/reverse_argparse.svg?label=merged+PRs + :target: https://github.com/sandialabs/reverse_argparse/pulls?q=is:pr+is:merged .. |OpenSSF Best Practices| image:: https://bestpractices.coreinfrastructure.org/projects/7632/badge :target: https://bestpractices.coreinfrastructure.org/projects/7632 +.. |Platforms| image:: https://anaconda.org/conda-forge/reverse-argparse/badges/platforms.svg .. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit :target: https://github.com/pre-commit/pre-commit .. |pre-commit.ci Status| image:: https://results.pre-commit.ci/badge/github/sandialabs/reverse_argparse/master.svg :target: https://results.pre-commit.ci/latest/github/sandialabs/reverse_argparse/master -.. |PyPI Version| image:: https://badge.fury.io/py/reverse-argparse.svg - :target: https://badge.fury.io/py/reverse-argparse .. |Python Version| image:: https://img.shields.io/badge/Python-3.8|3.9|3.10|3.11|3.12-blue.svg .. |Security: Bandit| image:: https://img.shields.io/badge/Security-Bandit-yellow.svg :target: https://github.com/PyCQA/bandit +**Releases:** + +* **PyPI:** |PyPI Version| |PyPI Downloads| +* **conda-forge:** |Anaconda Version| |Anaconda Downloads| + +.. |PyPI Version| image:: https://badge.fury.io/py/reverse-argparse.svg + :target: https://badge.fury.io/py/reverse-argparse +.. |PyPI Downloads| image:: https://img.shields.io/pypi/dm/reverse-argparse +.. |Anaconda Version| image:: https://anaconda.org/conda-forge/reverse-argparse/badges/version.svg + :target: https://anaconda.org/conda-forge/reverse-argparse +.. |Anaconda Downloads| image:: https://anaconda.org/conda-forge/reverse-argparse/badges/downloads.svg + The ``reverse_argparse`` module provides a means of undoing the argument parsing provided by :mod:`argparse`. That is, it can take a :class:`argparse.Namespace` of parsed command line arguments, along with the