From 22338900d61eae2e43a940bf89845fa92f077e10 Mon Sep 17 00:00:00 2001 From: Evan Mattson Date: Wed, 1 Oct 2025 09:30:41 +0900 Subject: [PATCH 1/2] Clarifications on installing packages in README --- python/README.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/python/README.md b/python/README.md index 7dc97bb13..bf4e3033f 100644 --- a/python/README.md +++ b/python/README.md @@ -2,17 +2,35 @@ ## Quick Install +We recommend two common installation paths depending on your use case. + +### 1. Development mode + +If you are exploring or developing locally, install the entire framework with all sub-packages: + ```bash -# Install agent-framework-core and all sub packages pip install agent-framework -# Install only core and Azure AI integration +``` + +This installs the core and every integration package, making sure that all features are available without additional steps. This is the simplest way to get started. + +### 2. Selective install + +If you only need specific integrations, you can install at a more granular level. This keeps dependencies lighter and focuses on what you actually plan to use. Some examples: + +```bash +# Core + Azure AI integration pip install agent-framework-azure-ai -# Install only core and Microsoft Copilot Studio integration + +# Core + Microsoft Copilot Studio integration pip install agent-framework-copilotstudio -# Install only core, Microsoft Copilot Studio and Azure AI integration -pip install agent-framework-microsoft agent-framework-azure-ai + +# Core + both Microsoft Copilot Studio and Azure AI integration +pip install agent-framework-copilotstudio agent-framework-azure-ai ``` +This selective approach is useful when you know which integrations you need, and it is the recommended way to set up lightweight environments. + Supported Platforms: - Python: 3.10+ From 6ac34a9579ab2c6c0d5f3eac922f746e524f855d Mon Sep 17 00:00:00 2001 From: Evan Mattson Date: Wed, 1 Oct 2025 09:41:36 +0900 Subject: [PATCH 2/2] Updates --- python/README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/python/README.md b/python/README.md index bf4e3033f..0e79f85c3 100644 --- a/python/README.md +++ b/python/README.md @@ -19,6 +19,11 @@ This installs the core and every integration package, making sure that all featu If you only need specific integrations, you can install at a more granular level. This keeps dependencies lighter and focuses on what you actually plan to use. Some examples: ```bash +# Core only +# includes Azure OpenAI and OpenAI support by default +# also includes workflows and orchestrations +pip install agent-framework-core + # Core + Azure AI integration pip install agent-framework-azure-ai @@ -26,7 +31,7 @@ pip install agent-framework-azure-ai pip install agent-framework-copilotstudio # Core + both Microsoft Copilot Studio and Azure AI integration -pip install agent-framework-copilotstudio agent-framework-azure-ai +pip install agent-framework-microsoft agent-framework-azure-ai ``` This selective approach is useful when you know which integrations you need, and it is the recommended way to set up lightweight environments.