ReleaseLogIt 0.18.0
Manage release notes for Python projects.
License: MIT
Requires Python: >=3.10

============
ReleaseLogIt
============

+-----------+------------------------------------------------------------------------------------+
|**General**| |maintenance_y| |semver| |license|                                                 |
+-----------+------------------------------------------------------------------------------------+
|**CI**     | |codestyle| |codecov|                                                              |
+-----------+------------------------------------------------------------------------------------+
|**PyPI**   | |pypi_release| |pypi_py_versions| |pypi_status| |pypi_format| |pypi_downloads|     |
+-----------+------------------------------------------------------------------------------------+
|**Github** | |gh_issues| |gh_language| |gh_last_commit|                                         |
+-----------+------------------------------------------------------------------------------------+


Manage release notes for Python projects.

    ReleaseIt keeps release notes for Python projects in a dict structure. It aims to standardise, facilitate and automate the management of release notes when publishing a project to GitHub, PyPI and ReadTheDocs. It is developed as part of the PackageIt project, but can be used independently as well. See also https://pypi.org/project/PackageIt/


.. General

.. |maintenance_n| image:: https://img.shields.io/badge/Maintenance%20Intended-✖-red.svg?style=flat-square
    :target: http://unmaintained.tech/
    :alt: Maintenance - not intended

.. |maintenance_y| image:: https://img.shields.io/badge/Maintenance%20Intended-✔-green.svg?style=flat-square
    :target: http://unmaintained.tech/
    :alt: Maintenance - intended

.. |license| image:: https://img.shields.io/pypi/l/ReleaseLogIt
    :target: https://github.com/BrightEdgeeServices/ReleaseLogIt/blob/master/LICENSE
    :alt: License

.. |semver| image:: https://img.shields.io/badge/Semantic%20Versioning-2.0.0-brightgreen.svg?style=flat-square
    :target: https://semver.org/
    :alt: Semantic Versioning - 2.0.0

.. |codestyle| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Code Style Black


.. CI

.. |pre_commit_ci| image:: https://img.shields.io/github/actions/workflow/status/BrightEdgeeServices/ReleaseLogIt/pre-commit.yml?label=pre-commit
    :target: https://github.com/BrightEdgeeServices/ReleaseLogIt/blob/master/.github/workflows/pre-commit.yml
    :alt: Pre-Commit

.. |gha_tests| image:: https://img.shields.io/github/actions/workflow/status/BrightEdgeeServices/ReleaseLogIt/ci.yml?label=ci
    :target: https://github.com/BrightEdgeeServices/ReleaseLogIt/blob/master/.github/workflows/ci.yml
    :alt: Test status

.. |gha_docu| image:: https://img.shields.io/readthedocs/sqlalchemyexample
    :target: https://github.com/BrightEdgeeServices/ReleaseLogIt/blob/master/.github/workflows/check-rst-documentation.yml
    :alt: Read the Docs

.. |codecov| image:: https://img.shields.io/codecov/c/gh/BrightEdgeeServices/ReleaseLogIt
    :target: https://app.codecov.io/gh/BrightEdgeeServices/ReleaseLogIt
    :alt: CodeCov


.. PyPI

.. |pypi_release| image:: https://img.shields.io/pypi/v/ReleaseLogIt
    :target: https://pypi.org/project/ReleaseLogIt/
    :alt: PyPI - Package latest release

.. |pypi_py_versions| image:: https://img.shields.io/pypi/pyversions/ReleaseLogIt
    :target: https://pypi.org/project/ReleaseLogIt/
    :alt: PyPI - Supported Python Versions

.. |pypi_format| image:: https://img.shields.io/pypi/wheel/ReleaseLogIt
    :target: https://pypi.org/project/ReleaseLogIt/
    :alt: PyPI - Format

.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/ReleaseLogIt
    :target: https://pypi.org/project/ReleaseLogIt/
    :alt: PyPI - Monthly downloads

.. |pypi_status| image:: https://img.shields.io/pypi/status/ReleaseLogIt
    :target: https://pypi.org/project/ReleaseLogIt/
    :alt: PyPI - Status


.. GitHub

.. |gh_issues| image:: https://img.shields.io/github/issues-raw/BrightEdgeeServices/ReleaseLogIt
    :target: https://github.com/BrightEdgeeServices/ReleaseLogIt/issues
    :alt: GitHub - Issue Counter

.. |gh_language| image:: https://img.shields.io/github/languages/top/BrightEdgeeServices/ReleaseLogIt
    :target: https://github.com/BrightEdgeeServices/ReleaseLogIt
    :alt: GitHub - Top Language

.. |gh_last_commit| image:: https://img.shields.io/github/last-commit/BrightEdgeeServices/ReleaseLogIt/master
    :target: https://github.com/BrightEdgeeServices/ReleaseLogIt/commit/master
    :alt: GitHub - Last Commit

.. |gh_deployment| image:: https://img.shields.io/github/deployments/BrightEdgeeServices/ReleaseLogIt/pypi
    :target: https://github.com/BrightEdgeeServices/ReleaseLogIt/deployments/pypi
    :alt: GitHub - PiPy Deployment