Skip to main content

An automated Python package release management tool with AI-powered changelog generation

Project description

Python Release Master

An automated Python package release management tool with AI-powered changelog generation.

Features

  • 🤖 AI-powered changelog generation
  • 🔄 Automated version bumping (semantic versioning)
  • 📦 PyPI publishing
  • 🏷️ Git tag and release creation
  • 🎯 Smart version bump suggestions

Installation

pip install python-release-master

Quick Start

  1. Create a .release-master.yaml configuration file in your project root:
version:
  files:
    - pyproject.toml  # Files containing version strings
  pattern: '\d+\.\d+\.\d+'

changelog:
  ai:
    enabled: true
    model: gpt-4-1106-preview
  sections:
    - Features
    - Bug Fixes
    - Documentation
    - Internal Changes

git:
  push: true
  tag_prefix: v
  release:
    enabled: true

pypi:
  publish: true
  1. Set required environment variables:
export OPENAI_API_KEY=your-openai-api-key
export PYPI_TOKEN=your-pypi-token
  1. Run the release command from your project directory:
release-master release-package

How It Works

  1. Analyzes git history to determine version bump type (major, minor, patch)
  2. Updates version in specified files
  3. Generates changelog using OpenAI
  4. Builds Python package
  5. Publishes to PyPI
  6. Creates Git tag and release

Configuration

Key configuration options in .release-master.yaml:

  • version.files: List of files containing version strings
  • changelog.ai.enabled: Enable/disable AI-powered changelog
  • git.push: Whether to push changes to remote
  • pypi.publish: Whether to publish to PyPI

CLI Commands

# Create a new release
release-master release-package

# Show help
release-master --help

# Show version
release-master --version

Requirements

  • Python 3.8+
  • OpenAI API key
  • PyPI token
  • Git repository

License

MIT License

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

python_release_master-0.4.1.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

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

python_release_master-0.4.1-py3-none-any.whl (3.3 kB view details)

Uploaded Python 3

File details

Details for the file python_release_master-0.4.1.tar.gz.

File metadata

  • Download URL: python_release_master-0.4.1.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for python_release_master-0.4.1.tar.gz
Algorithm Hash digest
SHA256 780d3c0fafcb7b369af39881fcdbae24633242f9dddfd46ab84aeb567aee96d4
MD5 29b77d5416bdb3aa0cab0879fa31f8f4
BLAKE2b-256 0297dd4a37680a9238e4e2639e90f3dbe68d12706aa028ad40db38f4ec8439fa

See more details on using hashes here.

File details

Details for the file python_release_master-0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for python_release_master-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8dfbae96b777af0fa352c5fd113595705f4b33627e739ce981816c71ef4359f9
MD5 daefbc4d1866183fb43d80235221b21e
BLAKE2b-256 8c11ff08eae159ebcb3ff07d4981af18986cf8381361fc80d1080f61d34de948

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