Skip to main content

PyVCC python version controller using conventional commits

Project description

PyVCC - Python Version Controller

Automatic semantic versioning based on conventional commits

PyVCC analyzes your Git repository's commit history and automatically determines the appropriate semantic version based on Conventional Commits specification.

codecov tests

Features

  • ✅ Automatic semantic version calculation (MAJOR.MINOR.PATCH)
  • ✅ Conventional Commits specification support
  • ✅ Breaking change detection (BREAKING CHANGE: footer or ! suffix)
  • ✅ Customizable starting version and commit
  • ✅ Fast Git repository analysis using pygit2

Installation

pip install pyvcc

Usage

Basic Usage

# Run from your Git repository root
pyvcc

Options

# Start from a specific version
pyvcc --initial-version 1.0.0

# Start analysis from a specific commit
pyvcc --initial-commit abc1234

# Verbose output
pyvcc --verbose

# Silent mode (errors only)
pyvcc --silent

Environment Variables

# Set repository root
PYVC_REPO_ROOT=/path/to/repo pyvcc

# Set initial version
PYVC_INITIAL_VERSION=2.0.0 pyvcc

# Set initial commit
PYVC_INITIAL_COMMIT=abc1234 pyvcc

How It Works

PyVCC analyzes each commit message in your Git history and applies semantic versioning rules:

  • MAJOR: Incremented for breaking changes (commit type with ! or BREAKING CHANGE: footer)
  • MINOR: Incremented for new features (feat: commits)
  • PATCH: Incremented for bug fixes (fix: commits)
  • NO BUMP: Other commit types (chore, docs, style, refactor, test, ci, build, perf)

Commit Message Examples

# Major version bump (breaking change)
feat!: Redesign API endpoint structure

# OR
feat: Migrate to new database schema

BREAKING CHANGE: Database schema has changed and requires migration

# Minor version bump (new feature)
feat: Add new user authentication API

# Patch version bump (bug fix)
fix: Resolve login error on Safari

# No version bump
chore: Update dependencies
docs: Update README installation instructions
style: Format code according to new style guide

Requirements

  • Python 3.10+
  • Git repository with commit history
  • Commit messages following Conventional Commits specification

Development

# Install development dependencies
pip install -e .[dev]

# Run tests
pytest

# Run with coverage
pytest --cov=pyvcc

License

MIT License - See LICENSE for details.

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

pyvcc-1.3.2.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

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

pyvcc-1.3.2-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file pyvcc-1.3.2.tar.gz.

File metadata

  • Download URL: pyvcc-1.3.2.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyvcc-1.3.2.tar.gz
Algorithm Hash digest
SHA256 d2d6aaea85c5647926bb67f4f81ff1b8a78818dcf7b89ae120d9f6aae6608747
MD5 b7826a062b206e62015ffe548d79ed81
BLAKE2b-256 8cd25eab7005145a8919a50dc637ff42f2b45d9614c709735fa537301333ec57

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyvcc-1.3.2.tar.gz:

Publisher: pypi-publish.yml on lcavalcante/python-version-controller

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyvcc-1.3.2-py3-none-any.whl.

File metadata

  • Download URL: pyvcc-1.3.2-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyvcc-1.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f43b3f54bf825604d60f71adae33ce43681ae3c170d4dd9ee0f6dd78e395e9bb
MD5 cdfa0d1da013c65a80f28bc23c1e9b09
BLAKE2b-256 960425932a57d03e100136924626e668dfa54d942ce3cf95e8b1b6550c351616

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyvcc-1.3.2-py3-none-any.whl:

Publisher: pypi-publish.yml on lcavalcante/python-version-controller

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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