Skip to content

docs(wrapper-py): install from git source until PyPI release lands #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
manojp99 merged 1 commit into from
Jun 25, 2026
Merged

docs(wrapper-py): install from git source until PyPI release lands #77

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 17 additions & 7 deletions wrappers/python-py/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading