Skip to content
R2X framework logoR2X framework logor2x-reeds

Installation

Use Python 3.11–3.13 (>=3.11,<3.14). Choose the environment that will execute your parser; project Python and the CLI’s managed Python are separate environments.

Published Python package

Section titled “Published Python package”

Follow environment setup to create and activate a virtual environment, then install from PyPI:

Terminal window
python -m pip install r2x-reeds && python -m pip show r2x-reeds

Follow the fixture tutorial for the separate data download. Fixtures are not installed package resources. The library has no standalone r2x-reeds executable.

For a project already managed with uv, uv add r2x-reeds is an alternative. Source checkouts are a contributor workflow, not the normal package-install path.

CLI runtime

Section titled “CLI runtime”

Install r2x-cli and check its managed Python before installing the plugin:

Terminal window
r2x --version && r2x python show

Install the package into the managed runtime. This changes that environment:

Terminal window
r2x install r2x-reeds

Verify discovery and inspect parser options without running a pipeline:

Terminal window
r2x list r2x-reeds && r2x run reeds-parser --help

If the CLI reports missing managed Python, use r2x python install before installing plugins. The list should include reeds-parser and the transform entry points. See CLI pipeline for a minimal run.

Continue with verify installation. For contributor source checkouts, see development setup.