Skip to content

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

Merged
manojp99 merged 1 commit into
mainfrom
docs/python-wrapper-install-from-source
Jun 25, 2026
Merged

docs(wrapper-py): install from git source until PyPI release lands#77
manojp99 merged 1 commit into
mainfrom
docs/python-wrapper-install-from-source

Conversation

@manojp99

Copy link
Copy Markdown
Collaborator

Summary

The amplifier-agent engine and amplifier-agent-py wrapper SDK are not yet published to PyPI. The previous README instructions directed users to install both from PyPI, which fails since the packages don't exist there yet.

This PR updates the Python wrapper SDK README to show the correct installation path:

  • Engine: Recommends the official install.sh curl one-liner (matches the canonical install pattern in the engine's own README), with manual git-source installs via uv / pipx as fallbacks
  • Wrapper: Installs from git source with the subdirectory pin since the wrapper lives at wrappers/python-py/
  • Temporary note: Adds a note at the top of the install section explaining PyPI publication is pending, so the commands will collapse to standard uv tool install amplifier-agent and pip install amplifier-agent-py once releases land

What was changed

  • Updated engine install instructions to recommend the official install.sh script
  • Updated wrapper install instructions to use git source with subdirectory resolution
  • Added a notice explaining these are temporary until PyPI releases are published
  • Expanded and clarified the install section to explain the "bring your own engine" model

This is a documentation-only change. No code changes, no new dependencies, no breaking changes to the actual package.

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>
@manojp99 manojp99 merged commit 0954c7d into main Jun 25, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant