Installation

r2x-core is a Python library, not a standalone executable. Current package metadata supports Python 3.11 through 3.14 (>=3.11,<3.15). Check the PyPI package page when choosing a released version.

Start with Prerequisites and environment if you need a fresh project.

Install with pip

In an activated virtual environment:

python -m pip install r2x-core
python -c "import r2x_core; print(r2x_core.__version__)"

The import check prints the installed version from that environment.

Add to a uv project

In an existing uv project:

uv add r2x-core
uv run python -c "import r2x_core; print(r2x_core.__version__)"

If you do not yet have a project, run uv init --bare in an empty directory first.

Upgrade

For a uv project, update its lockfile and environment:

uv lock --upgrade-package r2x-core
uv sync
uv run python -c "import r2x_core; print(r2x_core.__version__)"

For a pip environment, use python -m pip install --upgrade r2x-core and repeat the import check in that same environment.

Orchestrate installed plugins

Install r2x-cli separately to run translator packages. r2x-core itself has no plugin entry point to run. The CLI manages its own Python environment; adding a package to a uv project does not install it there. See getting started for direct library usage.

Continue with Verify installation and first use.