Moderne licensed

Change Python dependency

Recipe IDorg.openrewrite.python.ChangeDependencyArtifactorg.openrewrite:rewrite-python

Change a dependency to a different package. Supports pyproject.toml, requirements.txt, and Pipfile. Searches all dependency scopes. For pyproject.toml, uv.lock, poetry.lock, and pdm.lock are regenerated natively without executing the package manager. For Pipfile, Pipfile.lock is regenerated natively by consulting the project's package index over the network. Not safe to use as a precondition: invokes the package manager or the network and publishes per-project state shared with other dependency recipes.

Single recipeMSAL

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.python.ChangeDependency")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite:rewrite-python:8.92.8")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.python.ChangeDependency --recipe-option "oldPackageName=requests" --recipe-option "newPackageName=httpx"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite:rewrite-python:RELEASE

Options

Name	Type	Description
`oldPackageName`required	`String`	The current PyPI package name to replace. e.g. `requests`
`newPackageName`required	`String`	The new PyPI package name. e.g. `httpx`
`newVersion`	`String`	Optional new PEP 508 version constraint. If not specified, the original version constraint is preserved. e.g. `>=0.24.0`

Data tables

Structured output this recipe can produce.

Python lock regeneration failuresLock files that could not be regenerated after a dependency edit, and why.org.openrewrite.python.table.PythonLockRegenerationFailures
Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats