Skip to main content

Python bytecode compiler and PyPI publishing toolkit for monorepos

Project description

sage-pypi-publisher

A tiny toolkit to compile Python packages to bytecode, build wheels, and publish to PyPI/TestPyPI. Extracted from SAGE's internal sage-dev tooling and made standalone.

Features

  • Copy a package tree and compile .py.pyc (keeps __init__.py and _version.py).
  • Auto-adjust pyproject.toml / MANIFEST.in to include compiled artifacts and binary extensions.
  • Build wheels with python -m build.
  • 🚀 NEW: Smart --for-pypi mode - one command for perfect PyPI publishing!
  • NEW: Universal wheel support - one wheel works on all Python 3.x versions!
  • NEW: Source distribution (sdist) support - users can install from source on any version
  • Upload via twine (with --dry-run by default).
  • Simple Typer-based CLI.

Solving the Multi-Version Problem

Problem: Your package declares support for Python 3.8-3.12, but you only upload a wheel for Python 3.11. Users on other versions can't install it!

Solution: sage-pypi-publisher now uses Smart Mode by default 🎯

# That's it! No extra flags needed - smart mode is automatic
sage-pypi-publisher build . --upload --no-dry-run

What happens automatically:

  • Pure Python packages: Builds universal wheel (py3-none-any) that works on ALL Python 3.x versions!
  • Packages with C extensions: Builds for current Python + provides source code for others
  • ✅ Always includes source distribution (sdist) as fallback
  • ✅ No need to build wheels for each Python version separately!

Why this works:

  • Universal wheel (py3-none-any): One file works on Python 3.8, 3.9, 3.10, 3.11, 3.12, and future versions!
  • Source distribution: If universal wheel doesn't work, users can compile from source
  • Zero configuration: Works perfectly out of the box!

Installation

pip install .
# or
pip install sage-pypi-publisher

CLI

Quick Start

🎯 Simplest Usage (Smart Mode - Default!)

# Just build - automatically chooses best strategy!
sage-pypi-publisher build .

# Build and upload to TestPyPI
sage-pypi-publisher build . --upload -r testpypi

# Build and upload to PyPI (production)
sage-pypi-publisher build . --upload --no-dry-run -r pypi

What Smart Mode Does (Automatically):

  • 🔍 Detects if your package is pure Python or has C extensions
  • 📦 Pure Python → builds universal wheel (works on ALL Python 3.x!)
  • 🔧 C extensions → builds for current Python version
  • 📚 Always includes source distribution (sdist)
  • ✅ Perfect for packages declaring Python 3.8+ support!

Manual Control (Advanced):

# Disable smart mode (old behavior - current Python only)
sage-pypi-publisher build . --no-for-pypi

# Force universal wheel
sage-pypi-publisher build . --universal

# Force specific mode
sage-pypi-publisher build . --mode public

All Commands

sage-pypi-publisher --help

# 🎯 Simplest: Build with smart mode (default!)
sage-pypi-publisher build .

# Build and upload to PyPI
sage-pypi-publisher build . --upload --no-dry-run

# Compile only (bytecode mode by default)
sage-pypi-publisher compile /path/to/pkg -o /tmp/out

# Compile in public mode (keep source)
sage-pypi-publisher compile /path/to/pkg -o /tmp/out --mode public

# Disable smart mode (old behavior)
sage-pypi-publisher build /path/to/pkg --no-for-pypi

# Force universal wheel (manual override)
sage-pypi-publisher build /path/to/pkg --universal

# Force manylinux build for C/C++ extensions
sage-pypi-publisher build /path/to/pkg --force-manylinux

# Upload an existing wheel
sage-pypi-publisher upload dist/yourpkg-0.1.0-py3-none-any.whl -r pypi --no-dry-run

Build Modes

  • --mode private (default): Compile to .pyc bytecode (保密模式 - protects source code)
  • --mode public: Keep .py source files (公开模式 - open source)
  • Aliases: bytecode = private, source = public

Python API

Basic Usage

from pathlib import Path
from pypi_publisher.compiler import BytecodeCompiler

# Create compiler
compiler = BytecodeCompiler(Path("/path/to/pkg"), mode="private")
compiled = compiler.compile_package()

# Build wheel
wheel = compiler.build_wheel(compiled)

# Upload to TestPyPI (safe default)
compiler.upload_wheel(wheel, repository="testpypi", dry_run=True)

PyPI Publishing Options

  • Smart Mode (default): Automatically chooses packaging strategy for PyPI.
  • --no-for-pypi: Disable smart mode and use current-interpreter build behavior.
  • --universal: Force py3-none-any wheel (pure Python only).
  • --sdist: Also build source distribution (.tar.gz).

For C/C++ extension packages targeting multiple Python versions, use cibuildwheel in CI.

Git Hooks

sage-pypi-publisher provides intelligent git hooks to simplify version management and PyPI publishing.

Hook Installation

sage-pypi-publisher install-hooks .

Hook Features

  • Version Guard: Detects if the current version is already published on PyPI.
  • Auto-bump on Conflict: Can auto-bump patch version when a duplicate release is detected.
  • Interactive Flow: Keeps release behavior explicit and visible during push.

Notes

  • Requires python -m build and twine available.
  • No backward compatibility with sage-dev CLI; PyPI commands have been removed from SAGE.
  • Designed to be monorepo-friendly but works with any package path that contains pyproject.toml.

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

isage_pypi_publisher-0.2.1.4.tar.gz (28.5 kB view details)

Uploaded Source

Built Distribution

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

isage_pypi_publisher-0.2.1.4-py2.py3-none-any.whl (30.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file isage_pypi_publisher-0.2.1.4.tar.gz.

File metadata

  • Download URL: isage_pypi_publisher-0.2.1.4.tar.gz
  • Upload date:
  • Size: 28.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for isage_pypi_publisher-0.2.1.4.tar.gz
Algorithm Hash digest
SHA256 8529b22fa8639c040b8d4f5b7c12287377354f2c704d85f2e1770bcbcef040b5
MD5 b42f218203fc50060bf09efd98deccc9
BLAKE2b-256 b673a508783b2343d901c896ab1fb78657ce54f152e5d38704fc6b66cd61bf12

See more details on using hashes here.

File details

Details for the file isage_pypi_publisher-0.2.1.4-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for isage_pypi_publisher-0.2.1.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 70e14b15680a7a1abe2cc2421598092aa659656d811e68b3c0eb6ce6f0a4e3f1
MD5 c87216b794bbba25d87265bb19104f28
BLAKE2b-256 cdba41703635c86ef9ab5a1285d8766537eb530731d3ea0f0f568c3f13897d78

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