mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Python: Update installation instructions (#1026)
* Update installation instructions * address comments
This commit is contained in:
committed by
GitHub
Unverified
parent
2d20e644df
commit
f7e9490494
@@ -1,9 +1,9 @@
|
||||
# Get Started with Microsoft Agent Framework A2A
|
||||
|
||||
Please install this package as the extra for `agent-framework`:
|
||||
Please install this package via pip:
|
||||
|
||||
```bash
|
||||
pip install agent-framework[a2a]
|
||||
pip install agent-framework-a2a
|
||||
```
|
||||
|
||||
## A2A Agent Integration
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
# Get Started with Microsoft Agent Framework Azure AI
|
||||
|
||||
Please install this package as the extra for `agent-framework`:
|
||||
Please install this package via pip:
|
||||
|
||||
```bash
|
||||
pip install agent-framework[azure_ai]
|
||||
pip install agent-framework-azure-ai
|
||||
```
|
||||
|
||||
and see the [README](https://github.com/microsoft/agent-framework/tree/main/python/README.md) for more information.
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
# Get Started with Microsoft Agent Framework Copilot Studio
|
||||
|
||||
Please install this package as the extra for `agent-framework`:
|
||||
Please install this package via pip:
|
||||
|
||||
```bash
|
||||
pip install agent-framework[copilotstudio]
|
||||
pip install agent-framework-copilotstudio
|
||||
```
|
||||
|
||||
## Copilot Studio Agent
|
||||
|
||||
@@ -13,11 +13,9 @@ Highlights
|
||||
## Quick Install
|
||||
|
||||
```bash
|
||||
pip install agent-framework[all]
|
||||
pip install agent-framework-core
|
||||
# Optional: Add Azure AI integration
|
||||
pip install agent-framework-azure-ai
|
||||
# Optional: Both
|
||||
pip install agent-framework-azure-ai agent-framework-copilotstudio
|
||||
```
|
||||
|
||||
Supported Platforms:
|
||||
|
||||
@@ -14,8 +14,7 @@ def __getattr__(name: str) -> Any:
|
||||
return getattr(importlib.import_module(PACKAGE_NAME), name)
|
||||
except ModuleNotFoundError as exc:
|
||||
raise ModuleNotFoundError(
|
||||
f"The '{PACKAGE_EXTRA}' extra is not installed, "
|
||||
f"please do `pip install agent-framework[{PACKAGE_EXTRA}]`"
|
||||
f"The '{PACKAGE_EXTRA}' extra is not installed, please do `pip install agent-framework-{PACKAGE_EXTRA}`"
|
||||
) from exc
|
||||
raise AttributeError(f"Module {PACKAGE_NAME} has no attribute {name}.")
|
||||
|
||||
|
||||
@@ -4,14 +4,14 @@
|
||||
import importlib
|
||||
from typing import Any
|
||||
|
||||
_IMPORTS: dict[str, tuple[str, list[str]]] = {
|
||||
"AzureAIAgentClient": ("agent_framework_azure_ai", ["azure_ai", "azure"]),
|
||||
"AzureOpenAIAssistantsClient": ("agent_framework.azure._assistants_client", []),
|
||||
"AzureOpenAIChatClient": ("agent_framework.azure._chat_client", []),
|
||||
"AzureAISettings": ("agent_framework_azure_ai", ["azure_ai", "azure"]),
|
||||
"AzureOpenAISettings": ("agent_framework.azure._shared", []),
|
||||
"AzureOpenAIResponsesClient": ("agent_framework.azure._responses_client", []),
|
||||
"get_entra_auth_token": ("agent_framework.azure._entra_id_authentication", []),
|
||||
_IMPORTS: dict[str, tuple[str, str]] = {
|
||||
"AzureAIAgentClient": ("agent_framework_azure_ai", "azure-ai"),
|
||||
"AzureOpenAIAssistantsClient": ("agent_framework.azure._assistants_client", "core"),
|
||||
"AzureOpenAIChatClient": ("agent_framework.azure._chat_client", "core"),
|
||||
"AzureAISettings": ("agent_framework_azure_ai", "azure-ai"),
|
||||
"AzureOpenAISettings": ("agent_framework.azure._shared", "core"),
|
||||
"AzureOpenAIResponsesClient": ("agent_framework.azure._responses_client", "core"),
|
||||
"get_entra_auth_token": ("agent_framework.azure._entra_id_authentication", "core"),
|
||||
}
|
||||
|
||||
|
||||
@@ -22,8 +22,7 @@ def __getattr__(name: str) -> Any:
|
||||
return getattr(importlib.import_module(package_name), name)
|
||||
except ModuleNotFoundError as exc:
|
||||
raise ModuleNotFoundError(
|
||||
f"The {' or '.join(package_extra)} extra is not installed, "
|
||||
f"please use `pip install agent-framework[{package_extra[0]}]`, "
|
||||
f"please use `pip install agent-framework-{package_extra}`, "
|
||||
"or update your requirements.txt or pyproject.toml file."
|
||||
) from exc
|
||||
raise AttributeError(f"Module `azure` has no attribute {name}.")
|
||||
|
||||
@@ -25,8 +25,7 @@ def __getattr__(name: str) -> Any:
|
||||
return getattr(importlib.import_module(PACKAGE_NAME), name)
|
||||
except ModuleNotFoundError as exc:
|
||||
raise ModuleNotFoundError(
|
||||
f"The '{PACKAGE_EXTRA}' extra is not installed, "
|
||||
f"please do `pip install agent-framework[{PACKAGE_EXTRA}]`"
|
||||
f"The '{PACKAGE_EXTRA}' extra is not installed, please do `pip install agent-framework-{PACKAGE_EXTRA}`"
|
||||
) from exc
|
||||
raise AttributeError(f"Module {PACKAGE_NAME} has no attribute {name}.")
|
||||
|
||||
|
||||
@@ -14,8 +14,7 @@ def __getattr__(name: str) -> Any:
|
||||
return getattr(importlib.import_module(PACKAGE_NAME), name)
|
||||
except ModuleNotFoundError as exc:
|
||||
raise ModuleNotFoundError(
|
||||
f"The '{PACKAGE_EXTRA}' extra is not installed, "
|
||||
f"please do `pip install agent-framework[{PACKAGE_EXTRA}]`"
|
||||
f"The '{PACKAGE_EXTRA}' extra is not installed, please do `pip install agent-framework-{PACKAGE_EXTRA}`"
|
||||
) from exc
|
||||
raise AttributeError(f"Module {PACKAGE_NAME} has no attribute {name}.")
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ def __getattr__(name: str) -> Any:
|
||||
except ModuleNotFoundError as exc:
|
||||
raise ModuleNotFoundError(
|
||||
f"The {' or '.join(package_extra)} extra is not installed, "
|
||||
f"please use `pip install agent-framework[{package_extra[0]}]`, "
|
||||
f"please use `pip install agent-framework-{package_extra[0]}`, "
|
||||
"or update your requirements.txt or pyproject.toml file."
|
||||
) from exc
|
||||
raise AttributeError(f"Module `azure` has no attribute {name}.")
|
||||
|
||||
@@ -14,8 +14,7 @@ def __getattr__(name: str) -> Any:
|
||||
return getattr(importlib.import_module(PACKAGE_NAME), name)
|
||||
except ModuleNotFoundError as exc:
|
||||
raise ModuleNotFoundError(
|
||||
f"The '{PACKAGE_EXTRA}' extra is not installed, "
|
||||
f"please do `pip install agent-framework[{PACKAGE_EXTRA}]`"
|
||||
f"The '{PACKAGE_EXTRA}' extra is not installed, please do `pip install agent-framework-{PACKAGE_EXTRA}`"
|
||||
) from exc
|
||||
raise AttributeError(f"Module {PACKAGE_NAME} has no attribute {name}.")
|
||||
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
# Get Started with Microsoft Agent Framework Mem0
|
||||
|
||||
Please install this package as the extra for `agent-framework`:
|
||||
Please install this package via pip:
|
||||
|
||||
```bash
|
||||
pip install agent-framework[mem0]
|
||||
pip install agent-framework-mem0
|
||||
```
|
||||
|
||||
## Memory Context Provider
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
# Get Started with Microsoft Agent Framework Redis
|
||||
|
||||
Please install this package as the extra for `agent-framework`:
|
||||
Please install this package via pip:
|
||||
|
||||
```bash
|
||||
pip install agent-framework[redis]
|
||||
pip install agent-framework-redis
|
||||
```
|
||||
|
||||
## Components
|
||||
|
||||
Reference in New Issue
Block a user