mergeway-python on Mergeway

Install mergeway-python

Mon, 01 Jan 0001 00:00:00 +0000

mergeway-python requires mergeway-cli to be available on PATH.

If you have not installed the CLI yet, follow the official guide first!

Install with `uv`

If you are adding mergeway-python to a project, install the published package with:

uv add mergeway

If you are working from a local checkout and want an editable install, run:

uv sync

After installation, continue to the getting started guide.

Get Started with mergeway-python

Mon, 01 Jan 0001 00:00:00 +0000

This guide walks through the standard workflow for using mergeway-python with an existing Mergeway repository. By the end, you will have generated Python models, connected to the repository, and run common read, write, and repository-level operations.

Before You Start

You need:

a Python environment with mergeway-python installed
mergeway-cli available on PATH
an existing Mergeway repository with a mergeway.yaml file

Step 1: Generate Python Models