Add Badges to Repo

[matthew-wong-bcg]

Issue

Currently, the README.rst file does not contain any displayed badges that represent the repository.

Additional details on the .rst file format are located here

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

• pypi
• anaconda version
• python versions
• code style (black)
• sphinx (doc build)
• license (apache)
• GitHub Action build status
• test coverage
• Contributor Convenant

Solution

• Update the Readme.rst file with the relevant badges
  • Add the following where the badges should be displayed (example)

.. Begin-Badges

|pypi| |conda| |python_versions| |code_style| |made_with_sphinx_doc| |License_badge|GHA|TestCov|Contributor_Convenant

.. End-Badges

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

.. Begin-Badges

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

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

.. |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

.. End-Badges

• Update the RELEASE_NOTES.rst file:
  • Increment a minor version here