From 1f56cb26f44927c9eb1b286e5e871b7b00c8e5f8 Mon Sep 17 00:00:00 2001 From: Manoj Prabhakar Paidiparthy Date: Wed, 24 Jun 2026 17:17:17 -0700 Subject: [PATCH] docs(wrapper-py): install from git source until PyPI release lands The amplifier-agent and amplifier-agent-py packages are not yet published to PyPI. Update the README to show the recommended install path: the official install.sh script for the engine, and git-source installs for both engine and wrapper. Add a note at the top of the install section explaining this is temporary until releases land on PyPI, at which point the commands collapse to standard `uv tool install amplifier-agent` and `pip install amplifier-agent-py`. Generated with [Amplifier](https://github.com/microsoft/amplifier) Co-Authored-By: Amplifier <240397093+microsoft-amplifier@users.noreply.github.com> --- wrappers/python-py/README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/wrappers/python-py/README.md b/wrappers/python-py/README.md index 286d9bb..224940b 100644 --- a/wrappers/python-py/README.md +++ b/wrappers/python-py/README.md @@ -6,22 +6,32 @@ This package mirrors the [TypeScript wrapper](https://github.com/microsoft/ampli ## Install model: bring your own engine -This wrapper does **not** depend on the engine package. The `amplifier-agent` binary is a runtime dependency that you install separately: +This wrapper does **not** depend on the engine package. The `amplifier-agent` binary is a runtime dependency that you install separately. + +> Neither `amplifier-agent` nor `amplifier-agent-py` is published to PyPI yet. Install both from the git source as shown below. Once releases land on PyPI, these commands will collapse to `uv tool install amplifier-agent` and `pip install amplifier-agent-py`. + +Install the engine binary (recommended — uses the official installer, which pins the latest release and primes the bundle cache): + +```bash +curl -fsSL https://raw.githubusercontent.com/microsoft/amplifier-agent/main/install.sh | bash +``` + +Or do it manually with `uv` / `pipx`: ```bash -# Recommended — isolated tool install -uv tool install amplifier-agent +# Isolated tool install from git source +uv tool install --from git+https://github.com/microsoft/amplifier-agent amplifier-agent # Or -pipx install amplifier-agent +pipx install git+https://github.com/microsoft/amplifier-agent ``` -Then install the wrapper into your host project: +Then install the wrapper into your host project, also from the git source (the wrapper lives in a subdirectory of the engine repo): ```bash -uv add amplifier-agent-py +uv add "amplifier-agent-py @ git+https://github.com/microsoft/amplifier-agent#subdirectory=wrappers/python-py" # or -pip install amplifier-agent-py +pip install "amplifier-agent-py @ git+https://github.com/microsoft/amplifier-agent#subdirectory=wrappers/python-py" ``` The wrapper discovers the binary in this order: