Skip to content

Installation

Requirements

  • Python 3.11 or later
  • Git (must be available on PATH)

Install from PyPI

pip install remanufacture

Install from source

git clone https://gitlab.com/Kencho1/remanufacture.git
cd remanufacture
pip install .

For development dependencies (linting, testing):

pip install -e ".[dev]"

Verify the installation

remanufacture --help

Initial configuration

On first use, create a settings.toml in your working directory (or the project root):

[default]
pipelines_dir = "./pipelines"
host = "0.0.0.0"
port = 8080
log_level = "INFO"

Create the pipelines directory:

mkdir pipelines

Each pipeline lives in its own subdirectory under pipelines/. See Getting Started for the next step.

Note

Settings can also be overridden with environment variables prefixed REMANUFACTURE_. See Configuration for details.