|
1 | | -# Microsoft Agent 365 Python SDK |
| 1 | +# Microsoft Agent 365 SDK - Python |
2 | 2 |
|
3 | | -The Microsoft Agent365 SDK provides comprehensive observability, tooling, and runtime capabilities for AI agents and tools built with Python. |
| 3 | +[](https://pypi.org/search/?q=microsoft-agents-a365) |
| 4 | +[](https://pypi.org/search/?q=microsoft-agents-a365) |
| 5 | +[](https://github.com/microsoft/Agent365-python/actions) |
| 6 | +[](LICENSE.md) |
| 7 | +[](https://www.python.org/) |
| 8 | +[](https://github.com/microsoft/Agent365-python/graphs/contributors) |
4 | 9 |
|
5 | | -## 📚 Library Documentation |
| 10 | +> #### Note: |
| 11 | +> Use the information in this README to contribute to this open-source project. To learn about using this SDK in your projects, refer to the [Microsoft Agent 365 Developer documentation](https://learn.microsoft.com/microsoft-agent-365/developer/). |
6 | 12 |
|
7 | | -Each library includes comprehensive documentation: |
| 13 | +The Microsoft Agent 365 SDK extends the Microsoft 365 Agents SDK with enterprise-grade capabilities for building sophisticated agents. This SDK provides comprehensive tooling for observability, notifications, runtime utilities, and development tools that help developers create production-ready agents for platforms including M365, Teams, Copilot Studio, and Webchat. |
8 | 14 |
|
9 | | -| Library | Purpose | Documentation | |
10 | | -|---------|---------|---------------| |
11 | | -| **Observability Core** | Core telemetry and tracing | [`/libraries/microsoft-agents-a365-observability-core/README.md`](./libraries/microsoft-agents-a365-observability-core/README.md) | |
12 | | -| **Runtime** | Environment management and utilities | [`/libraries/microsoft-agents-a365-runtime/README.md`](./libraries/microsoft-agents-a365-runtime/README.md) | |
13 | | -| **Tooling** | MCP server configuration and utilities | [`/libraries/microsoft-agents-a365-tooling/README.md`](./libraries/microsoft-agents-a365-tooling/README.md) | |
14 | | -| **OpenAI Extensions** | OpenAI integration and observability | [`/libraries/microsoft-agents-a365-observability-extensions-openai/README.md`](./libraries/microsoft-agents-a365-observability-extensions-openai/README.md) | |
15 | | -| **LangChain Extensions** | LangChain integration and observability | [`/libraries/microsoft-agents-a365-observability-extensions-langchain/README.md`](./libraries/microsoft-agents-a365-observability-extensions-langchain/README.md) | |
16 | | -| **Semantic Kernel Extensions** | Semantic Kernel integration | [`/libraries/microsoft-agents-a365-observability-extensions-semantickernel/README.md`](./libraries/microsoft-agents-a365-observability-extensions-semantickernel/README.md) | |
| 15 | +The Microsoft Agent 365 SDK focuses on four core areas: |
| 16 | + |
| 17 | +- **Observability**: Comprehensive tracing, caching, and monitoring capabilities for agent applications |
| 18 | +- **Notifications**: Agent notification services and models for handling user notifications |
| 19 | +- **Runtime**: Core utilities and extensions for agent runtime operations |
| 20 | +- **Tooling**: Developer tools and utilities for building sophisticated agent applications |
| 21 | + |
| 22 | +## Current Project State |
| 23 | + |
| 24 | +This project is currently in active development. Packages are published to PyPI as they become available. |
| 25 | + |
| 26 | +### Public PyPI feed |
| 27 | + |
| 28 | +The best way to consume this SDK is via our PyPI packages found here: [pypi.org](https://pypi.org/search/?q=microsoft-agents-a365). All packages begin with **microsoft-agents-a365**. |
| 29 | + |
| 30 | +## Working with this codebase |
| 31 | + |
| 32 | +### Prerequisites |
| 33 | + |
| 34 | +- Python 3.10 or later |
| 35 | +- pip or uv package manager |
| 36 | +- Git |
| 37 | + |
| 38 | +### Building the project |
| 39 | + |
| 40 | +1. Clone the repository: |
| 41 | + |
| 42 | + ```bash |
| 43 | + git clone https://github.com/microsoft/Agent365-python.git |
| 44 | + cd Agent365-python |
| 45 | + ``` |
| 46 | + |
| 47 | +2. Create a virtual environment: |
| 48 | + |
| 49 | + ```bash |
| 50 | + python -m venv .venv |
| 51 | + source .venv/bin/activate # On Windows: .venv\Scripts\activate |
| 52 | + ``` |
| 53 | + |
| 54 | +3. Build the packages: |
| 55 | + |
| 56 | + ```bash |
| 57 | + # Set the version |
| 58 | + export AGENT365_PYTHON_SDK_PACKAGE_VERSION="0.1.0" # On Windows: $env:AGENT365_PYTHON_SDK_PACKAGE_VERSION = "0.1.0" |
| 59 | + |
| 60 | + # Build all packages |
| 61 | + uv build --all-packages --wheel |
| 62 | + ``` |
| 63 | + |
| 64 | +4. Run tests: |
| 65 | + |
| 66 | + ```bash |
| 67 | + pytest tests/ |
| 68 | + ``` |
| 69 | + |
| 70 | +For more detailed build instructions, see the [BUILD.md](BUILD.md). |
| 71 | + |
| 72 | +## Project Structure |
| 73 | + |
| 74 | +- **libraries/microsoft-agents-a365-notifications**: Microsoft Agent 365 Notifications SDK - Agent notification services and models |
| 75 | +- **libraries/microsoft-agents-a365-observability-core**: Microsoft Agent 365 Observability Core - Core observability functionality |
| 76 | +- **libraries/microsoft-agents-a365-observability-extensions-agentframework**: Agent Framework observability extensions |
| 77 | +- **libraries/microsoft-agents-a365-observability-extensions-langchain**: LangChain observability extensions |
| 78 | +- **libraries/microsoft-agents-a365-observability-extensions-openai**: OpenAI observability extensions |
| 79 | +- **libraries/microsoft-agents-a365-observability-extensions-semantickernel**: Semantic Kernel observability extensions |
| 80 | +- **libraries/microsoft-agents-a365-runtime**: Microsoft Agent 365 Runtime - Core runtime utilities and extensions |
| 81 | +- **libraries/microsoft-agents-a365-tooling**: Microsoft Agent 365 Tooling SDK - Agent tooling and MCP integration |
| 82 | +- **libraries/microsoft-agents-a365-tooling-extensions-agentframework**: Agent Framework tooling extensions |
| 83 | +- **libraries/microsoft-agents-a365-tooling-extensions-azureaifoundry**: Azure AI Foundry tooling extensions |
| 84 | +- **libraries/microsoft-agents-a365-tooling-extensions-openai**: OpenAI tooling extensions |
| 85 | +- **libraries/microsoft-agents-a365-tooling-extensions-semantickernel**: Semantic Kernel tooling extensions |
| 86 | +- **samples/**: For sample applications, see the [Agent365-Samples Repository](https://github.com/microsoft/Agent365-Samples/tree/main/python) |
| 87 | +- **tests/**: Unit and integration tests |
| 88 | + |
| 89 | +## Support |
| 90 | + |
| 91 | +For issues, questions, or feedback: |
| 92 | + |
| 93 | +- **Issues**: Please file issues in the [GitHub Issues](https://github.com/microsoft/Agent365-python/issues) section |
| 94 | +- **Documentation**: See the [Microsoft Agents 365 developer documentation](https://learn.microsoft.com/microsoft-agent-365/developer/) |
| 95 | +- **Security**: For security issues, please see [SECURITY.md](SECURITY.md) |
| 96 | + |
| 97 | +## Contributing |
| 98 | + |
| 99 | +This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>. |
| 100 | + |
| 101 | +When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. |
| 102 | + |
| 103 | +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. |
| 104 | + |
| 105 | +## Useful Links |
| 106 | + |
| 107 | +### Microsoft 365 Agent SDK |
| 108 | + |
| 109 | +The core SDK for building conversational AI agents for Microsoft 365 platforms. |
| 110 | + |
| 111 | +- [Microsoft 365 Agents SDK](https://aka.ms/agents) |
| 112 | +- [Agents-for-net repository](https://github.com/Microsoft/Agents-for-net) |
| 113 | +- [Agents-for-js repository](https://github.com/Microsoft/Agents-for-js) |
| 114 | +- [Agents-for-python repository](https://github.com/Microsoft/Agents-for-python) |
| 115 | +- [Microsoft 365 Agents documentation](https://learn.microsoft.com/microsoft-365/agents-sdk/) |
| 116 | + |
| 117 | +### Microsoft Agents 365 SDK |
| 118 | + |
| 119 | +Enterprise-grade extensions for observability, notifications, runtime utilities, and developer tools. |
| 120 | + |
| 121 | +- [Agent365-dotnet repository](https://github.com/microsoft/Agent365-dotnet) |
| 122 | +- [Agent365-python repository](https://github.com/microsoft/Agent365-python) - You are here |
| 123 | +- [Agent365-nodejs repository](https://github.com/microsoft/Agent365-nodejs) |
| 124 | +- [Agent365-Samples repository](https://github.com/microsoft/Agent365-Samples) |
| 125 | +- [Microsoft Agent 365 developer documentation](https://learn.microsoft.com/microsoft-agent-365/developer/) |
| 126 | + |
| 127 | +### Additional Resources |
| 128 | + |
| 129 | +- [Python Documentation](https://learn.microsoft.com/python/api/?view=m365-agents-sdk&preserve-view=true) |
17 | 130 |
|
18 | 131 | ## 📋 **Telemetry** |
19 | 132 |
|
20 | | -Data Collection. The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices. |
| 133 | +Data Collection. The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices. |
| 134 | + |
| 135 | +## Trademarks |
| 136 | + |
| 137 | +*Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653.* |
| 138 | + |
| 139 | +## License |
| 140 | + |
| 141 | +Copyright (c) Microsoft Corporation. All rights reserved. |
| 142 | + |
| 143 | +Licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details. |
0 commit comments