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

# Install from PyPI
pip install python-release-master

# Verify installation
release-master --version

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

Development

If you want to contribute or develop the package:

  1. Clone the repository:
git clone https://github.com/kareemaly/python-release-master.git
cd python-release-master
  1. Create and activate a virtual environment:
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
  1. Install in development mode with dev dependencies:
pip install -e ".[dev]"
  1. Run the development version:
# Use python -m when running from source
python -m python_release_master release-package

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.6.tar.gz (16.4 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.6-py3-none-any.whl (24.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for python_release_master-0.4.6.tar.gz
Algorithm Hash digest
SHA256 1634469464bebefcce7d36cf8c6a92f286e380df1cad2dfb4c395d100f6cb0f4
MD5 85722e1d313740f81dafe2170de42b39
BLAKE2b-256 8a292105dc074f7f4122785072b3a1fbcb5b72df540d02e6fe793d49c5de875c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_release_master-0.4.6-py3-none-any.whl
Algorithm Hash digest
SHA256 adc707daae7ab75f6525f754622f66109b6681dc0b63fdffc7e85850b85ae538
MD5 1467489d1e1f0e0b5ff83890ac03adaf
BLAKE2b-256 6fc4f4484a10da3a8d6da962c59a746b7839510be5799b1deb6dce6704a422db

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