Skip to main content

Replace actions/setup-python with astral-sh/setup-uv

org.openrewrite.github.SetupPythonToUv

Replace actions/setup-python action with astral-sh/setup-uv action for faster Python environment setup and dependency management.

Benefits of UV:

  • Significantly faster package installation and environment setup
  • Built-in dependency resolution and locking
  • Integrated caching for improved CI performance
  • Drop-in replacement for pip workflows

Transformations applied:

  • actions/setup-python@v5 → astral-sh/setup-uv@v6
  • cache: 'pip' → enable-cache: 'true'
  • pip install -r requirements.txt → uv sync (configurable strategy)
  • python -m <module> → uv run <module>
  • Removes unnecessary pip install --upgrade pip steps

Sync strategies:

  • basic: Basic synchronization (uv sync)
  • locked: Use locked dependencies (uv sync --locked)
  • full: Install all extras and dev dependencies (uv sync --all-extras --dev)

See the UV GitHub integration guide for more details.

Recipe source​

GitHub: SetupPythonToUv.java, Issue Tracker, Maven Central

This recipe is available under the Moderne Source Available License.

Options​

TypeNameDescriptionExample
StringuvVersionOptional. The version of the astral-sh/setup-uv action to use. Defaults to v6.v6
StringsyncStrategyOptional. Strategy for the uv sync command replacement. Valid options: basic, locked, fulllocked
BooleantransformPipCommandsOptional. Whether to transform pip install commands to uv equivalents:
- pip install -r requirements.txt → uv sync
- pip install . → uv sync
- python -m pytest → uv run pytest

When disabled, only the action itself is replaced. Defaults to true.		true
BooleanenableCacheOptional. Whether to automatically convert cache: 'pip' to enable-cache: 'true' for UV's built-in caching. When disabled, cache settings are left unchanged. Defaults to true.true

Example​

Parameters​
ParameterValue
uvVersionnull
syncStrategynull
transformPipCommandsnull
enableCachenull
Before​
.github/workflows/test.yml
name: Test

on: [push]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.11'
      - run: pip install -r requirements.txt
      - run: python -m pytest
After​
.github/workflows/test.yml
name: Test

on: [push]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: astral-sh/setup-uv@v6
        with:
          python-version: '3.11'
      - run: uv sync
      - run: uv run pytest

Usage​

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe SetupPythonToUv

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite.recipe:rewrite-github-actions:3.18.1

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.