← All recipes
Moderne licensed

Migrate to pyproject.toml

Recipe IDorg.openrewrite.python.migrate.MigrateToPyprojectTomlArtifactorg.openrewrite.recipe:rewrite-migrate-python

Migrate Python projects from requirements.txt and/or setup.cfg to pyproject.toml with hatchling build backend.

Single recipeProprietary

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.migrate.MigrateToPyprojectToml")
}

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.recipe:rewrite-migrate-python:0.14.0")
}

Then run

./gradlew rewriteRun

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.python.migrate.MigrateToPyprojectToml

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

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

Options

NameTypeDescription
projectNameStringProject name for [project].name. Inferred from setup.cfg, then from the Git repository name, or defaults to "my-project".
e.g. my-project
requiresPythonStringPython version constraint for requires-python. Inferred from setup.cfg or defaults to ">=3.9".
e.g. >=3.9

Data tables

Structured output this recipe can produce.

  • 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