Skip to main content
Documentation Status https://github.com/MacHu-GWU/semantic_branch-project/actions/workflows/main.yml/badge.svg https://codecov.io/gh/MacHu-GWU/semantic_branch-project/branch/main/graph/badge.svg https://img.shields.io/pypi/v/semantic-branch.svg https://img.shields.io/pypi/l/semantic-branch.svg https://img.shields.io/pypi/pyversions/semantic-branch.svg https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to semantic_branch Documentation

https://semantic-branch.readthedocs.io/en/latest/_static/semantic_branch-logo.png

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.

Install

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

$ pip install semantic-branch

To upgrade to latest version:

$ pip install --upgrade semantic-branch

Metadata

Release files for semantic-branch 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for semantic-branch 0.1.1
File Size Uploaded
semantic_branch-0.1.1.tar.gz 10.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for semantic-branch 0.1.1
File Interpreter ABI Platform
semantic_branch-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 21.6 kB

Release files / semantic_branch-0.1.1.tar.gz

Download URL semantic_branch-0.1.1.tar.gz
Size 10.3 kB
Tags Source
SHA-256 checksum
How to use checksums
c8a3ef12c6f0b0dd32573b25ca0c8fdd0be1465b0759b0989ac6c957c318fca1
BLAKE2b-256 checksum
How to use checksums
a5af720fbcbf3bccabba7730f3bcb38911f501d85a4f923edba39cf68911fb19
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.8

Release files / semantic_branch-0.1.1-py3-none-any.whl

Download URL semantic_branch-0.1.1-py3-none-any.whl
Size 11.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a89611bd7e0e2977fb2652d8f8c3af15eaabf50b061ff68ee1a82b4644be2870
BLAKE2b-256 checksum
How to use checksums
558aab254e3ea0c332c9ccff18b799605ac796f69cc450bc434feb3ed06a8e0f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.8

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page