https://mergewayhq.github.io/docs/how-to/python/Recent content in Python SDK guides on MergewayHugoenhttps://mergewayhq.github.io/docs/how-to/python/install/Mon, 01 Jan 0001 00:00:00 +0000https://mergewayhq.github.io/docs/how-to/python/install/<h1 id="install-the-python-sdk">Install the Python SDK<a class="anchor" href="#install-the-python-sdk"></a></h1> <p>The published package is named <code>mergeway</code>. It requires Python 3.13 or newer and runs <code>mergeway-cli</code> as a subprocess, so install both before using the SDK.</p> <h2 id="install-the-cli-dependency">Install the CLI dependency<a class="anchor" href="#install-the-cli-dependency"></a></h2> <p>Follow <a href="../../install/">Install Mergeway tools</a> if <code>mergeway-cli</code> is not already available. Verify that the Python process will be able to find it:</p> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>mergeway-cli version</span></span></code></pre></div><p>If the binary is not on <code>PATH</code>, pass its path as <code>cli_binary</code> when you construct a <code>Database</code>.</p>https://mergewayhq.github.io/docs/how-to/python/getting-started/Mon, 01 Jan 0001 00:00:00 +0000https://mergewayhq.github.io/docs/how-to/python/getting-started/<h1 id="get-started-with-mergeway-python">Get started with <code>mergeway-python</code><a class="anchor" href="#get-started-with-mergeway-python"></a></h1> <p>This guide connects the Python SDK to an existing Mergeway repository, generates typed models, and demonstrates its read, write, validation, formatting, and export operations.</p> <h2 id="before-you-start">Before you start<a class="anchor" href="#before-you-start"></a></h2> <p>You need:</p> <ul> <li>Python 3.13 or newer with the <a href="../install/"><code>mergeway</code> package installed</a></li> <li><code>mergeway-cli</code> available on <code>PATH</code></li> <li>an existing repository with a <code>mergeway.yaml</code> file</li> </ul> <p>The mutation examples change repository files. Run them on a disposable branch and replace the example entity, fields, and identifiers with values valid for your schema.</p>