release-pypi

A PyPI package publishing tool based on Typer framework, simplifying the process of publishing Python packages to PyPI.

Installation

pip install release-pypi

Quick Start

# Publish to PyPI
release-pypi

# Dry run (build and check only)
release-pypi --dry-run

# Skip confirmation
release-pypi --yes

# Specify build and twine versions
release-pypi --build-version "~=1.0" --twine-version "~=4.0"

Features

• Reliable: Ensures stable and reproducible release process
• Secure: Protects sensitive credentials from leakage
• Robust: Comprehensive error handling and edge case handling
• Easy to Use: Clear command-line interface and friendly user prompts

Usage

Basic Usage

# Full release
release-pypi

# Dry run
release-pypi --dry-run

# Skip confirmation
release-pypi --yes

Credential Configuration

# Method 1: Environment variables (recommended)
export TWINE_USERNAME="__token__"
export TWINE_PASSWORD="pypi-xxx"
release-pypi

# Method 2: .pypirc configuration file
cat > ~/.pypirc << 'EOF'
[pypi]
  username = __token__
  password = pypi-xxx
EOF
release-pypi

Command Line Options

Environment Variables

Development

Setup

# Clone the repository
git clone https://github.com/codearts/release-pypi.git
cd release-pypi

# Create virtual environment
python -m venv .venv
source .venv/bin/activate  # Linux/Mac
# .venv\Scripts\activate  # Windows

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

Running Tests

pytest

Code Formatting

black src tests examples

Linting

ruff check src tests examples

Type Checking

mypy src

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Changelog

See CHANGELOG.md for a list of changes in each version.

Acknowledgments

• Inspired by twine
• Built with Typer, build, hatchling

Contact

CodeArts - email@example.com

Project Link: https://github.com/codearts/release-pypi