Skip to main content

Easily toggle between development and production packages with uv. Quickly close development packages locally.

Project description

Release Notes Downloads GitHub CI Status License: MIT

Python Uv Development Package Toggler

A utility script for easily switching between local development and published sources for Python packages in your pyproject.toml. Here's the original issue which spawned this project.

Here's a quick video demonstration of how to use the tool:

How to Toggle Between PyPi and Git Package Versions

Features

  • Automatically toggles between local development paths and GitHub sources
  • Preserves TOML file comments and structure
  • Automatically clones repositories when switching to local development
  • Supports branch tracking
  • Falls back to PyPI metadata if direct GitHub repository is not found
  • Integrates with GitHub CLI for username detection
  • Creates necessary TOML structure (tool.uv.sources) if it doesn't exist
  • Automatically runs uv sync --upgrade-package after successful updates

Installation

uv add --dev uv-development-toggle

uv tool install uv-development-toggle

Usage

To toggle a package activemodel:

uv-development-toggle activemodel --local

Then, after you push to a custom branch, reference the branch in your pyproject.toml:

uv-development-toggle activemodel --git

To revert a package to PyPI:

uv-development-toggle activemodel --pypi

This will:

  1. Check if the package exists in your PYTHON_DEVELOPMENT_TOGGLE directory
  2. If switching to local and the repository doesn't exist, clone it automatically (attempts to determine the repo URL from pypi information)
  3. Update your pyproject.toml with the appropriate source configuration (creating the tool.uv.sources structure if needed)
  4. Preserve any existing branch information when toggling
  5. Automatically run uv sync --upgrade-package <package_name> to apply the changes

Arguments

  • MODULE_NAME: The name of the Python module to toggle
  • --local: Force using local development path
  • --git: Force using git source
  • --pypi: Revert to default PyPI source

Environment Variables

  • PYTHON_DEVELOPMENT_TOGGLE: Directory for local development repositories (default: "pypi")

This project was created from iloveitaly/python-package-template

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

uv_development_toggle-0.7.0.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

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

uv_development_toggle-0.7.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file uv_development_toggle-0.7.0.tar.gz.

File metadata

  • Download URL: uv_development_toggle-0.7.0.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for uv_development_toggle-0.7.0.tar.gz
Algorithm Hash digest
SHA256 3014bf0c11161ea3640bfc0a3482014b634a3bfea77e2fc16452f0f911e7cc87
MD5 41b5d1d37999d8c76921b85eb9ad757d
BLAKE2b-256 611c328fba26c3d652e05d15aff474730014562c7a3028baa0df724b7b1299f5

See more details on using hashes here.

File details

Details for the file uv_development_toggle-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: uv_development_toggle-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for uv_development_toggle-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ec0f29f65591ecd9e157b25c3e75922489d907b3a1ca123496d0a078009f4dac
MD5 93b63fa14cc2cc5f1395783ca0b93414
BLAKE2b-256 b5378c073f6b50ed1a8478939cb496b078bee4d1dda835b47c12d8b61ff65b8f

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