BCG-X-Official / artkit

Automated prompt-based testing and evaluation of Gen AI applications
https://bcg-x-official.github.io/artkit/_generated/home.html
Apache License 2.0
76 stars 6 forks source link

Add Badges #29

Open matthew-wong-bcg opened 6 days ago

matthew-wong-bcg commented 6 days ago

Issue

Currently, the README.rst file does not contain any displayed badges that represent the repository. Some are in pypi_description.rst but don't have full list (see below)

Additional details on the .rst file format are located here

Specifically, we'd like to add badges for the following:

Here's an example with all badges we want to replicate. Note: the example uses Azure DevOps to add the test coverage badge but this repo utilizes GitHub Actions so a different approach is required and will entail changes to the artkit-release-pipeline.yml. Given it's a more complex change, a separate issue documents the approach:

Solution

|pypi| |conda| |python_versions| |code_style| |made_with_sphinx_doc| |license_badge| |Contributor_Convenant|

.. End-Badges

-
     - Add the targets for the URLs where the badges should point to (example)

.. Begin-Badges

.. |pypi| image:: https://badge.fury.io/py/artkit.svg :target: https://pypi.org/project/artkit/

.. |conda| image:: https://anaconda.org/bcg_gamma/gamma-facet/badges/version.svg :target: https://anaconda.org/BCG_Gamma/artkit

.. |python_versions| image:: https://img.shields.io/badge/python-3.10|3.11|3.12-blue.svg :target: https://www.python.org/downloads/release/python-3100/

.. |code_style| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black

.. |made_with_sphinx_doc| image:: https://img.shields.io/badge/Made%20with-Sphinx-1f425f.svg :target: https://bcg-x-official.github.io/facet/index.html

.. |license_badge| image:: https://img.shields.io/badge/License-Apache%202.0-olivegreen.svg :target: https://opensource.org/licenses/Apache-2.0

.. image:: https://github.com/BCG-X-Official/artkit/actions/workflows/artkit-release-pipeline.yml/badge.svg :target: https://github.com/BCG-X-Official/artkit/actions/workflows/artkit-release-pipeline.yml :alt: ARTKIT Release Pipeline

.. |Contributor_Convenant| image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg :target: CODE_OF_CONDUCT.md

.. End-Badges


- Update the `RELEASE_NOTES.rst` file: 
     - Increment a minor version [here](https://github.com/BCG-X-Official/artkit/blob/5d0f52198e4a6c07378d73a38166b786a483de5f/RELEASE_NOTES.rst#L4)