Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 6 additions & 6 deletions python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ We recommend two common installation paths depending on your use case.
If you are exploring or developing locally, install the entire framework with all sub-packages:

```bash
pip install agent-framework --pre
pip install agent-framework
```

This installs the core and every integration package, making sure that all features are available without additional steps. The `--pre` flag is required while Agent Framework is in preview. This is the simplest way to get started.
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.
Comment thread
giles17 marked this conversation as resolved.

### 2. Selective install

Expand All @@ -22,16 +22,16 @@ If you only need specific integrations, you can install at a more granular level
# Core only
# includes Azure OpenAI and OpenAI support by default
# also includes workflows and orchestrations
pip install agent-framework-core --pre
pip install agent-framework-core

# Core + Azure AI Foundry integration
pip install agent-framework-foundry --pre
pip install agent-framework-foundry

# Core + Microsoft Copilot Studio integration
pip install agent-framework-copilotstudio --pre
pip install agent-framework-copilotstudio

# Core + both Microsoft Copilot Studio and Azure AI Foundry integration
pip install agent-framework-microsoft agent-framework-foundry --pre
pip install agent-framework-microsoft agent-framework-foundry
Comment thread
giles17 marked this conversation as resolved.
```

This selective approach is useful when you know which integrations you need, and it is the recommended way to set up lightweight environments.
Expand Down
2 changes: 1 addition & 1 deletion python/packages/a2a/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Please install this package via pip:

```bash
pip install agent-framework-a2a --pre
pip install agent-framework-a2a
```

## A2A Agent Integration
Expand Down
2 changes: 1 addition & 1 deletion python/packages/anthropic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Please install this package via pip:

```bash
pip install agent-framework-anthropic --pre
pip install agent-framework-anthropic
```

## Anthropic Integration
Expand Down
2 changes: 1 addition & 1 deletion python/packages/azure-ai-search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Please install this package via pip:

```bash
pip install agent-framework-azure-ai-search --pre
pip install agent-framework-azure-ai-search
```

## Azure AI Search Integration
Expand Down
2 changes: 1 addition & 1 deletion python/packages/azure-ai/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Please install this package via pip:

```bash
pip install agent-framework-azure-ai --pre
pip install agent-framework-azure-ai
```

## Foundry Memory Context Provider
Expand Down
2 changes: 1 addition & 1 deletion python/packages/azure-cosmos/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Please install this package via pip:

```bash
pip install agent-framework-azure-cosmos --pre
pip install agent-framework-azure-cosmos
```

## Azure Cosmos DB History Provider
Expand Down
2 changes: 1 addition & 1 deletion python/packages/azurefunctions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Please install this package via pip:

```bash
pip install agent-framework-azurefunctions --pre
pip install agent-framework-azurefunctions
```

## Durable Agent Extension
Expand Down
2 changes: 1 addition & 1 deletion python/packages/bedrock/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Install the provider package:

```bash
pip install agent-framework-bedrock --pre
pip install agent-framework-bedrock
```

## Bedrock Integration
Expand Down
2 changes: 1 addition & 1 deletion python/packages/chatkit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Specifically, it mirrors the [Agent SDK integration](https://github.com/openai/c
## Installation

```bash
pip install agent-framework-chatkit --pre
pip install agent-framework-chatkit
```

This will install `agent-framework-core` and `openai-chatkit` as dependencies.
Expand Down
2 changes: 1 addition & 1 deletion python/packages/claude/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Please install this package via pip:

```bash
pip install agent-framework-claude --pre
pip install agent-framework-claude
```

## Claude Agent
Expand Down
2 changes: 1 addition & 1 deletion python/packages/copilotstudio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Please install this package via pip:

```bash
pip install agent-framework-copilotstudio --pre
pip install agent-framework-copilotstudio
```

## Copilot Studio Agent
Expand Down
6 changes: 3 additions & 3 deletions python/packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ Highlights
## Quick Install

```bash
pip install agent-framework-core --pre
pip install agent-framework-core
# Optional: Add Azure AI Foundry integration
pip install agent-framework-foundry --pre
pip install agent-framework-foundry
# Optional: Add OpenAI integration
pip install agent-framework-openai --pre
pip install agent-framework-openai
```

Supported Platforms:
Expand Down
2 changes: 1 addition & 1 deletion python/packages/declarative/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Please install this package via pip:

```bash
pip install agent-framework-declarative --pre
pip install agent-framework-declarative
```

## Declarative features
Expand Down
2 changes: 1 addition & 1 deletion python/packages/durabletask/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Please install this package via pip:

```bash
pip install agent-framework-durabletask --pre
pip install agent-framework-durabletask
```

## Durable Task Integration
Expand Down
2 changes: 1 addition & 1 deletion python/packages/github_copilot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Please install this package via pip:

```bash
pip install agent-framework-github-copilot --pre
pip install agent-framework-github-copilot
```

## GitHub Copilot Agent
Expand Down
2 changes: 1 addition & 1 deletion python/packages/mem0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Please install this package via pip:

```bash
pip install agent-framework-mem0 --pre
pip install agent-framework-mem0
```

## Memory Context Provider
Expand Down
2 changes: 1 addition & 1 deletion python/packages/ollama/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Please install this package as the extra for `agent-framework`:

```bash
pip install agent-framework-ollama --pre
pip install agent-framework-ollama
```

and see the [README](https://github.com/microsoft/agent-framework/tree/main/python/README.md) for more information.
Expand Down
2 changes: 1 addition & 1 deletion python/packages/openai/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This package provides:
## Installation

```bash
pip install agent-framework-openai --pre
pip install agent-framework-openai
```

## Which chat client should I use?
Expand Down
2 changes: 1 addition & 1 deletion python/packages/orchestrations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Orchestration patterns for Microsoft Agent Framework. This package provides high
## Installation

```bash
pip install agent-framework-orchestrations --pre
pip install agent-framework-orchestrations
```

## Orchestration Patterns
Expand Down
2 changes: 1 addition & 1 deletion python/packages/redis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Please install this package via pip:

```bash
pip install agent-framework-redis --pre
pip install agent-framework-redis
```
Comment thread
giles17 marked this conversation as resolved.

## Components
Expand Down
2 changes: 1 addition & 1 deletion python/samples/01-get-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ concepts of **Agent Framework** one step at a time.
## Prerequisites

```bash
pip install agent-framework --pre
pip install agent-framework
```

Set the required environment variables:
Expand Down
6 changes: 3 additions & 3 deletions python/samples/02-agents/declarative/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This folder contains sample code demonstrating how to use the **Microsoft Agent
Install the declarative package via pip:

```bash
pip install agent-framework-declarative --pre
pip install agent-framework-declarative
```

## What is Declarative Agent Framework?
Expand Down Expand Up @@ -43,7 +43,7 @@ Shows how to create an agent that can search and retrieve information from Micro
- Uses Azure CLI credentials for authentication
- Leverages MCP to access Microsoft documentation tools

**Requirements**: `pip install agent-framework-foundry --pre`
**Requirements**: `pip install agent-framework-foundry`

**Key concepts**: Azure AI Foundry integration, MCP server usage, async patterns, resource management

Expand All @@ -53,7 +53,7 @@ Shows how to create an agent using an inline YAML string rather than a file.

- Uses Azure AI Foundry v2 Client with instructions.

**Requirements**: `pip install agent-framework-foundry --pre`
**Requirements**: `pip install agent-framework-foundry`

**Key concepts**: Inline YAML definition.

Expand Down
2 changes: 1 addition & 1 deletion python/samples/02-agents/declarative/inline_yaml.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
It uses a Azure AI Client so it needs the credential to be passed into the AgentFactory.

Prerequisites:
- `pip install agent-framework-foundry agent-framework-declarative --pre`
- `pip install agent-framework-foundry agent-framework-declarative`
Comment thread
giles17 marked this conversation as resolved.
- Set the following environment variables in a .env file or your environment:
- FOUNDRY_PROJECT_ENDPOINT
- FOUNDRY_MODEL
Expand Down
2 changes: 1 addition & 1 deletion python/samples/02-agents/declarative/mcp_tool_yaml.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
(no secrets passed in API calls - connection name references pre-configured auth)

Prerequisites:
- `pip install agent-framework-openai agent-framework-declarative --pre`
- `pip install agent-framework-openai agent-framework-declarative`
Comment thread
giles17 marked this conversation as resolved.
- For OpenAI example: Set OPENAI_API_KEY and GITHUB_PAT environment variables
- For Azure AI example: Set up a Foundry connection in your Azure AI project
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This directory contains examples demonstrating how to use the `GitHubCopilotAgen
2. **GitHub Copilot Subscription**: An active GitHub Copilot subscription
3. **Install the package**:
```bash
pip install agent-framework-github-copilot --pre
pip install agent-framework-github-copilot
```

## Environment Variables
Expand Down
4 changes: 2 additions & 2 deletions python/samples/AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,10 @@ code here
## Package install

```bash
pip install agent-framework --pre
pip install agent-framework
```

The `--pre` flag is needed during preview. `openai` is a core dependency.
`openai` is a core dependency.
Comment thread
giles17 marked this conversation as resolved.

## Current API notes

Expand Down
2 changes: 1 addition & 1 deletion python/samples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Start with `01-get-started/` and work through the numbered files:
## Prerequisites

```bash
pip install agent-framework --pre
pip install agent-framework
```

### Environment Variables
Expand Down
Loading