Moderne licensed

Python dependency insight

Recipe IDorg.openrewrite.python.search.DependencyInsightArtifactorg.openrewrite:rewrite-python

Find direct and transitive Python dependencies matching a package name pattern. Results include dependencies that either directly match or transitively include a matching dependency.

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.search.DependencyInsight")
}

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.search.DependencyInsight --recipe-option "packageNamePattern=requests*"

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

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

Options

Name	Type	Description
`packageNamePattern`required	`String`	A glob pattern to match Python package names (PEP 503 normalized). Use `` as a wildcard. e.g. `requests`
`scope`	`String`	Match dependencies in the specified scope. All scopes are searched by default. e.g. `project.dependencies`
`onlyDirect`	`Boolean`	If enabled, transitive dependencies will not be considered. All dependencies are searched by default. e.g. `true`

Data tables

Structured output this recipe can produce.

Python dependencies in useDirect and transitive dependencies in use in Python projects.org.openrewrite.python.table.PythonDependenciesInUse
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