Installation¶

Installing with pip (Recommended)¶

To install using pip, run the following command:

python -m pip install python-re3data

This will automatically install compatible versions of all dependencies, including httpx and xsdata.

Note

It is highly recommended creating a virtual environment before installing the project. This will help keep your dependencies isolated and prevent conflicts with other projects. You can use venv to create and manage virtual environments.

You can also install optional dependencies, such as the command line interface, by using pip install python-re3data with the [cli] flag:

python -m pip install "python-re3data[cli]"

For more details, see Optional Dependencies.

Requirements¶

Python 3.10 or higher installed on your machine

Alternative: Use uv instead of pip

uv¹ is a fast Python package installer and resolver, written in Rust.

Create a virtual environment in the current directory:

uv venv

Install the project and its dependencies:

uv pip install python-re3data

Pulling the Docker Image¶

Pull the official image from GHCR:

docker pull ghcr.io/afuetterer/python-re3data:latest

Note

The optional [cli] dependency group is pre-installed in the Docker image and the re3data executable is provided as an entry point.

Run the container with:

$ docker run --rm afuetterer/python-re3data --version
0.5.0

Alternative: Use Podman instead of Docker

Podman is an open-source containerization platform that allows you to create, run, and manage Linux containers.

Pull the official image from GHCR:

podman pull ghcr.io/afuetterer/python-re3data:latest

Run the container with:

$ podman run --rm afuetterer/python-re3data --version
0.5.0

Requirements¶

Docker² or Podman³ installed and running on your machine

Installing from Source with Git¶

Clone the repository from GitHub:

git clone https://github.com/afuetterer/python-re3data.git

Change into the directory:

cd python-re3data

Finally, install the project and its dependencies:

python -m pip install .

Requirements¶

Git installed on your machine
Python 3.10 or higher installed on your machine

Dependencies¶

Required Dependencies¶

python-re3data requires the following dependencies:

Package	Version	Description
httpx	>= 0.27	A modern and efficient HTTP client library, handles all API interactions.
xsdata	>= 24.5	A powerful tool for generating Python dataclasses from XML schemas, simplifies processing of API responses.

Optional dependencies¶

Command Line Interface¶

Install with python -m pip install "python-re3data[cli]".

Package	Version	Description
typer	>= 0.12	A popular library for building command-line interfaces, powers the user-friendly interface.

For installation instructions, see Getting Started. ↩
For installation instructions, see Install Docker Engine. ↩
For installation instructions, see Podman Installation Instructions. ↩