Skip to content
Merged
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
31 changes: 27 additions & 4 deletions python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,40 @@

## 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 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
# 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

# Core + both Microsoft Copilot Studio and Azure AI integration
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.

Supported Platforms:

- Python: 3.10+
Expand Down