Skip to main content

A comprehensive Python library for managing semantic git branch naming conventions, providing robust validation and categorization of branch names across different development workflows.

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

semantic_branch-0.1.1.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

semantic_branch-0.1.1-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file semantic_branch-0.1.1.tar.gz.

File metadata

  • Download URL: semantic_branch-0.1.1.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for semantic_branch-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c8a3ef12c6f0b0dd32573b25ca0c8fdd0be1465b0759b0989ac6c957c318fca1
MD5 56407af5492f8587fb8cd7a951ff9a92
BLAKE2b-256 a5af720fbcbf3bccabba7730f3bcb38911f501d85a4f923edba39cf68911fb19

See more details on using hashes here.

File details

Details for the file semantic_branch-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for semantic_branch-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a89611bd7e0e2977fb2652d8f8c3af15eaabf50b061ff68ee1a82b4644be2870
MD5 f0e48b5f117bdb156a5d3685c8a37539
BLAKE2b-256 558aab254e3ea0c332c9ccff18b799605ac796f69cc450bc434feb3ed06a8e0f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page