Moderne licensed

Add Python dependency

Recipe IDorg.openrewrite.python.AddDependency

Artifactorg.openrewrite:rewrite-python

Add a dependency to a Python project. Supports pyproject.toml (with scope/group targeting), requirements.txt, and Pipfile. 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

Usage

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

mod run . --recipe org.openrewrite.python.AddDependency --recipe-option "packageName=requests"

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

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

Options

Name	Type	Description
`packageName`required	`String`	The PyPI package name to add. e.g. `requests`
`version`	`String`	The PEP 508 version constraint (e.g., `>=2.28.0`). e.g. `>=2.28.0`
`scope`	`String`	The dependency scope to add to. For pyproject.toml this targets a specific TOML section. For requirements files, `null` matches all files, empty string matches only `requirements.txt`, and a value like `dev` matches `requirements-dev.txt`. Defaults to `project.dependencies`. e.g. `project.dependencies`
`groupName`	`String`	The group name, required when scope is `project.optional-dependencies` or `dependency-groups`. e.g. `dev`

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