semantic-branch 0.1.1
A comprehensive Python library for managing semantic git branch naming conventions, providing robust validation and categorization of branch names across different development workflows.
License: MIT
Requires Python: <4.0,>=3.9


.. image:: https://readthedocs.org/projects/semantic-branch/badge/?version=latest
    :target: https://semantic-branch.readthedocs.io/en/latest/
    :alt: Documentation Status

.. image:: https://github.com/MacHu-GWU/semantic_branch-project/actions/workflows/main.yml/badge.svg
    :target: https://github.com/MacHu-GWU/semantic_branch-project/actions?query=workflow:CI

.. image:: https://codecov.io/gh/MacHu-GWU/semantic_branch-project/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/MacHu-GWU/semantic_branch-project

.. image:: https://img.shields.io/pypi/v/semantic-branch.svg
    :target: https://pypi.python.org/pypi/semantic-branch

.. image:: https://img.shields.io/pypi/l/semantic-branch.svg
    :target: https://pypi.python.org/pypi/semantic-branch

.. image:: https://img.shields.io/pypi/pyversions/semantic-branch.svg
    :target: https://pypi.python.org/pypi/semantic-branch

.. image:: https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/semantic_branch-project/blob/main/release-history.rst

.. image:: https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/semantic_branch-project

------

.. image:: https://img.shields.io/badge/Link-API-blue.svg
    :target: https://semantic-branch.readthedocs.io/en/latest/py-modindex.html

.. image:: https://img.shields.io/badge/Link-Install-blue.svg
    :target: `install`_

.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
    :target: https://github.com/MacHu-GWU/semantic_branch-project

.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
    :target: https://github.com/MacHu-GWU/semantic_branch-project/issues

.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
    :target: https://github.com/MacHu-GWU/semantic_branch-project/issues

.. image:: https://img.shields.io/badge/Link-Download-blue.svg
    :target: https://pypi.org/pypi/semantic-branch#files


Welcome to ``semantic_branch`` Documentation
==============================================================================
.. image:: https://semantic-branch.readthedocs.io/en/latest/_static/semantic_branch-logo.png
    :target: https://semantic-branch.readthedocs.io/en/latest/


What is Semantic Branch?
------------------------------------------------------------------------------
``semantic_branch`` is a Python library that provides a comprehensive system for working with semantic git branch names. It offers a structured approach to branch naming that helps developers and CI/CD systems understand the purpose and type of work being done on a branch.

The library allows you to:

- Validate branch names against a set of semantic rules
- Detect branch types (feature, fix, release, etc.)
- Ensure consistent branch naming across development workflows
- Provide robust branch name parsing and categorization

Key Features:

- Validate semantic branch names
- Detect branch types using predefined semantic stubs
- Support for various branch naming conventions

For a complete guide with detailed usage examples and advanced techniques, visit the `comprehensive documentation <https://semantic-branch.readthedocs.io/en/latest/>`_.

.. _install:

Install
------------------------------------------------------------------------------

``semantic_branch`` is released on PyPI, so all you need is to:

.. code-block:: console

    $ pip install semantic-branch

To upgrade to latest version:

.. code-block:: console

    $ pip install --upgrade semantic-branch