microsoft-agents-storage-blob 0.4.0.dev16__tar.gz → 0.5.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of microsoft-agents-storage-blob might be problematic. Click here for more details.

Files changed (17) hide show
  1. microsoft_agents_storage_blob-0.5.0/LICENSE +21 -0
  2. microsoft_agents_storage_blob-0.5.0/PKG-INFO +156 -0
  3. microsoft_agents_storage_blob-0.5.0/microsoft_agents_storage_blob.egg-info/PKG-INFO +156 -0
  4. {microsoft_agents_storage_blob-0.4.0.dev16 → microsoft_agents_storage_blob-0.5.0}/microsoft_agents_storage_blob.egg-info/SOURCES.txt +2 -0
  5. microsoft_agents_storage_blob-0.5.0/microsoft_agents_storage_blob.egg-info/requires.txt +3 -0
  6. {microsoft_agents_storage_blob-0.4.0.dev16 → microsoft_agents_storage_blob-0.5.0}/pyproject.toml +9 -2
  7. microsoft_agents_storage_blob-0.5.0/readme.md +133 -0
  8. microsoft_agents_storage_blob-0.4.0.dev16/PKG-INFO +0 -14
  9. microsoft_agents_storage_blob-0.4.0.dev16/microsoft_agents_storage_blob.egg-info/PKG-INFO +0 -14
  10. microsoft_agents_storage_blob-0.4.0.dev16/microsoft_agents_storage_blob.egg-info/requires.txt +0 -3
  11. {microsoft_agents_storage_blob-0.4.0.dev16 → microsoft_agents_storage_blob-0.5.0}/microsoft_agents/storage/blob/__init__.py +0 -0
  12. {microsoft_agents_storage_blob-0.4.0.dev16 → microsoft_agents_storage_blob-0.5.0}/microsoft_agents/storage/blob/blob_storage.py +0 -0
  13. {microsoft_agents_storage_blob-0.4.0.dev16 → microsoft_agents_storage_blob-0.5.0}/microsoft_agents/storage/blob/blob_storage_config.py +0 -0
  14. {microsoft_agents_storage_blob-0.4.0.dev16 → microsoft_agents_storage_blob-0.5.0}/microsoft_agents_storage_blob.egg-info/dependency_links.txt +0 -0
  15. {microsoft_agents_storage_blob-0.4.0.dev16 → microsoft_agents_storage_blob-0.5.0}/microsoft_agents_storage_blob.egg-info/top_level.txt +0 -0
  16. {microsoft_agents_storage_blob-0.4.0.dev16 → microsoft_agents_storage_blob-0.5.0}/setup.cfg +0 -0
  17. {microsoft_agents_storage_blob-0.4.0.dev16 → microsoft_agents_storage_blob-0.5.0}/setup.py +0 -0
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) Microsoft Corporation.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE
@@ -0,0 +1,156 @@
1
+ Metadata-Version: 2.4
2
+ Name: microsoft-agents-storage-blob
3
+ Version: 0.5.0
4
+ Summary: A blob storage library for Microsoft Agents
5
+ Author: Microsoft Corporation
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://github.com/microsoft/Agents
8
+ Classifier: Programming Language :: Python :: 3
9
+ Classifier: Programming Language :: Python :: 3.10
10
+ Classifier: Programming Language :: Python :: 3.11
11
+ Classifier: Programming Language :: Python :: 3.12
12
+ Classifier: Programming Language :: Python :: 3.13
13
+ Classifier: Programming Language :: Python :: 3.14
14
+ Classifier: Operating System :: OS Independent
15
+ Requires-Python: >=3.10
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+ Requires-Dist: microsoft-agents-hosting-core==0.5.0
19
+ Requires-Dist: azure-core
20
+ Requires-Dist: azure-storage-blob
21
+ Dynamic: license-file
22
+ Dynamic: requires-dist
23
+
24
+ # Microsoft Agents Storage - Blob
25
+
26
+ [![PyPI version](https://img.shields.io/pypi/v/microsoft-agents-storage-blob)](https://pypi.org/project/microsoft-agents-storage-blob/)
27
+
28
+ Azure Blob Storage integration for Microsoft 365 Agents SDK. This library provides persistent storage for conversation state, user data, and custom agent information using Azure Blob Storage.
29
+
30
+ This library implements the storage interface for the Microsoft 365 Agents SDK using Azure Blob Storage as the backend. It enables your agents to persist conversation state, user preferences, and custom data across sessions. Perfect for production deployments where you need reliable, scalable cloud storage.
31
+
32
+ # What is this?
33
+ This library is part of the **Microsoft 365 Agents SDK for Python** - a comprehensive framework for building enterprise-grade conversational AI agents. The SDK enables developers to create intelligent agents that work across multiple platforms including Microsoft Teams, M365 Copilot, Copilot Studio, and web chat, with support for third-party integrations like Slack, Facebook Messenger, and Twilio.
34
+
35
+ ## Release Notes
36
+ <table style="width:100%">
37
+ <tr>
38
+ <th style="width:20%">Version</th>
39
+ <th style="width:20%">Date</th>
40
+ <th style="width:60%">Release Notes</th>
41
+ </tr>
42
+ <tr>
43
+ <td>0.5.0</td>
44
+ <td>2025-10-22</td>
45
+ <td>
46
+ <a href="https://github.com/microsoft/Agents-for-python/blob/main/changelog.md">
47
+ 0.5.0 Release Notes
48
+ </a>
49
+ </td>
50
+ </tr>
51
+ </table>
52
+
53
+ ## Packages Overview
54
+
55
+ We offer the following PyPI packages to create conversational experiences based on Agents:
56
+
57
+ | Package Name | PyPI Version | Description |
58
+ |--------------|-------------|-------------|
59
+ | `microsoft-agents-activity` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-activity)](https://pypi.org/project/microsoft-agents-activity/) | Types and validators implementing the Activity protocol spec. |
60
+ | `microsoft-agents-hosting-core` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-hosting-core)](https://pypi.org/project/microsoft-agents-hosting-core/) | Core library for Microsoft Agents hosting. |
61
+ | `microsoft-agents-hosting-aiohttp` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-hosting-aiohttp)](https://pypi.org/project/microsoft-agents-hosting-aiohttp/) | Configures aiohttp to run the Agent. |
62
+ | `microsoft-agents-hosting-teams` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-hosting-teams)](https://pypi.org/project/microsoft-agents-hosting-teams/) | Provides classes to host an Agent for Teams. |
63
+ | `microsoft-agents-storage-blob` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-storage-blob)](https://pypi.org/project/microsoft-agents-storage-blob/) | Extension to use Azure Blob as storage. |
64
+ | `microsoft-agents-storage-cosmos` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-storage-cosmos)](https://pypi.org/project/microsoft-agents-storage-cosmos/) | Extension to use CosmosDB as storage. |
65
+ | `microsoft-agents-authentication-msal` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-authentication-msal)](https://pypi.org/project/microsoft-agents-authentication-msal/) | MSAL-based authentication for Microsoft Agents. |
66
+
67
+ Additionally we provide a Copilot Studio Client, to interact with Agents created in CopilotStudio:
68
+
69
+ | Package Name | PyPI Version | Description |
70
+ |--------------|-------------|-------------|
71
+ | `microsoft-agents-copilotstudio-client` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-copilotstudio-client)](https://pypi.org/project/microsoft-agents-copilotstudio-client/) | Direct to Engine client to interact with Agents created in CopilotStudio |
72
+
73
+ ## Installation
74
+
75
+ ```bash
76
+ pip install microsoft-agents-storage-blob
77
+ ```
78
+
79
+ **Benefits:**
80
+ - ✅ No secrets in code
81
+ - ✅ Managed Identity support
82
+ - ✅ Automatic token renewal
83
+ - ✅ Fine-grained access control via Azure RBAC
84
+
85
+ ### Configuration Parameters
86
+
87
+ | Parameter | Type | Required | Description |
88
+ |-----------|------|----------|-------------|
89
+ | `container_name` | `str` | Yes | Name of the blob container to use |
90
+ | `connection_string` | `str` | No* | Storage account connection string |
91
+ | `url` | `str` | No* | Blob service URL (e.g., `https://account.blob.core.windows.net`) |
92
+ | `credential` | `TokenCredential` | No** | Azure credential for authentication |
93
+
94
+ *Either `connection_string` OR (`url` + `credential`) must be provided
95
+ **Required when using `url`
96
+
97
+
98
+ ### Azure Managed Identity
99
+
100
+ When running in Azure (App Service, Functions, Container Apps), use Managed Identity:
101
+
102
+ ```python
103
+ from azure.identity import ManagedIdentityCredential
104
+
105
+ config = BlobStorageConfig(
106
+ container_name="agent-storage",
107
+ url="https://myaccount.blob.core.windows.net",
108
+ credential=ManagedIdentityCredential()
109
+ )
110
+ ```
111
+
112
+ **Azure RBAC Roles Required:**
113
+ - `Storage Blob Data Contributor` - For read/write access
114
+ - `Storage Blob Data Reader` - For read-only access
115
+
116
+ **Benefits of switching to BlobStorage:**
117
+ - ✅ Data persists across restarts
118
+ - ✅ Scalable to millions of items
119
+ - ✅ Multi-instance support (load balancing)
120
+ - ✅ Automatic backups and geo-replication
121
+ - ✅ Built-in monitoring and diagnostics
122
+
123
+ ## Best Practices
124
+
125
+ 1. **Use Token Authentication in Production** - Avoid storing connection strings; use Managed Identity or DefaultAzureCredential
126
+ 2. **Initialize Once** - Call `storage.initialize()` during app startup, not on every request
127
+ 3. **Implement Retry Logic** - Handle transient failures with exponential backoff
128
+ 4. **Monitor Performance** - Use Azure Monitor to track storage operations
129
+ 5. **Set Lifecycle Policies** - Configure automatic cleanup of old data in Azure Portal
130
+ 6. **Use Consistent Naming** - Establish key naming conventions (e.g., `user:{id}`, `conversation:{id}`)
131
+ 7. **Batch Operations** - Read/write multiple items together when possible
132
+
133
+ ## Key Classes Reference
134
+
135
+ - **`BlobStorage`** - Main storage implementation using Azure Blob Storage
136
+ - **`BlobStorageConfig`** - Configuration settings for connection and authentication
137
+ - **`StoreItem`** - Base class for data models (inherit to create custom types)
138
+
139
+ # Quick Links
140
+
141
+ - 📦 [All SDK Packages on PyPI](https://pypi.org/search/?q=microsoft-agents)
142
+ - 📖 [Complete Documentation](https://aka.ms/agents)
143
+ - 💡 [Python Samples Repository](https://github.com/microsoft/Agents/tree/main/samples/python)
144
+ - 🐛 [Report Issues](https://github.com/microsoft/Agents-for-python/issues)
145
+
146
+ # Sample Applications
147
+
148
+ |Name|Description|README|
149
+ |----|----|----|
150
+ |Quickstart|Simplest agent|[Quickstart](https://github.com/microsoft/Agents/blob/main/samples/python/quickstart/README.md)|
151
+ |Auto Sign In|Simple OAuth agent using Graph and GitHub|[auto-signin](https://github.com/microsoft/Agents/blob/main/samples/python/auto-signin/README.md)|
152
+ |OBO Authorization|OBO flow to access a Copilot Studio Agent|[obo-authorization](https://github.com/microsoft/Agents/blob/main/samples/python/obo-authorization/README.md)|
153
+ |Semantic Kernel Integration|A weather agent built with Semantic Kernel|[semantic-kernel-multiturn](https://github.com/microsoft/Agents/blob/main/samples/python/semantic-kernel-multiturn/README.md)|
154
+ |Streaming Agent|Streams OpenAI responses|[azure-ai-streaming](https://github.com/microsoft/Agents/blob/main/samples/python/azureai-streaming/README.md)|
155
+ |Copilot Studio Client|Console app to consume a Copilot Studio Agent|[copilotstudio-client](https://github.com/microsoft/Agents/blob/main/samples/python/copilotstudio-client/README.md)|
156
+ |Cards Agent|Agent that uses rich cards to enhance conversation design |[cards](https://github.com/microsoft/Agents/blob/main/samples/python/cards/README.md)|
@@ -0,0 +1,156 @@
1
+ Metadata-Version: 2.4
2
+ Name: microsoft-agents-storage-blob
3
+ Version: 0.5.0
4
+ Summary: A blob storage library for Microsoft Agents
5
+ Author: Microsoft Corporation
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://github.com/microsoft/Agents
8
+ Classifier: Programming Language :: Python :: 3
9
+ Classifier: Programming Language :: Python :: 3.10
10
+ Classifier: Programming Language :: Python :: 3.11
11
+ Classifier: Programming Language :: Python :: 3.12
12
+ Classifier: Programming Language :: Python :: 3.13
13
+ Classifier: Programming Language :: Python :: 3.14
14
+ Classifier: Operating System :: OS Independent
15
+ Requires-Python: >=3.10
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+ Requires-Dist: microsoft-agents-hosting-core==0.5.0
19
+ Requires-Dist: azure-core
20
+ Requires-Dist: azure-storage-blob
21
+ Dynamic: license-file
22
+ Dynamic: requires-dist
23
+
24
+ # Microsoft Agents Storage - Blob
25
+
26
+ [![PyPI version](https://img.shields.io/pypi/v/microsoft-agents-storage-blob)](https://pypi.org/project/microsoft-agents-storage-blob/)
27
+
28
+ Azure Blob Storage integration for Microsoft 365 Agents SDK. This library provides persistent storage for conversation state, user data, and custom agent information using Azure Blob Storage.
29
+
30
+ This library implements the storage interface for the Microsoft 365 Agents SDK using Azure Blob Storage as the backend. It enables your agents to persist conversation state, user preferences, and custom data across sessions. Perfect for production deployments where you need reliable, scalable cloud storage.
31
+
32
+ # What is this?
33
+ This library is part of the **Microsoft 365 Agents SDK for Python** - a comprehensive framework for building enterprise-grade conversational AI agents. The SDK enables developers to create intelligent agents that work across multiple platforms including Microsoft Teams, M365 Copilot, Copilot Studio, and web chat, with support for third-party integrations like Slack, Facebook Messenger, and Twilio.
34
+
35
+ ## Release Notes
36
+ <table style="width:100%">
37
+ <tr>
38
+ <th style="width:20%">Version</th>
39
+ <th style="width:20%">Date</th>
40
+ <th style="width:60%">Release Notes</th>
41
+ </tr>
42
+ <tr>
43
+ <td>0.5.0</td>
44
+ <td>2025-10-22</td>
45
+ <td>
46
+ <a href="https://github.com/microsoft/Agents-for-python/blob/main/changelog.md">
47
+ 0.5.0 Release Notes
48
+ </a>
49
+ </td>
50
+ </tr>
51
+ </table>
52
+
53
+ ## Packages Overview
54
+
55
+ We offer the following PyPI packages to create conversational experiences based on Agents:
56
+
57
+ | Package Name | PyPI Version | Description |
58
+ |--------------|-------------|-------------|
59
+ | `microsoft-agents-activity` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-activity)](https://pypi.org/project/microsoft-agents-activity/) | Types and validators implementing the Activity protocol spec. |
60
+ | `microsoft-agents-hosting-core` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-hosting-core)](https://pypi.org/project/microsoft-agents-hosting-core/) | Core library for Microsoft Agents hosting. |
61
+ | `microsoft-agents-hosting-aiohttp` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-hosting-aiohttp)](https://pypi.org/project/microsoft-agents-hosting-aiohttp/) | Configures aiohttp to run the Agent. |
62
+ | `microsoft-agents-hosting-teams` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-hosting-teams)](https://pypi.org/project/microsoft-agents-hosting-teams/) | Provides classes to host an Agent for Teams. |
63
+ | `microsoft-agents-storage-blob` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-storage-blob)](https://pypi.org/project/microsoft-agents-storage-blob/) | Extension to use Azure Blob as storage. |
64
+ | `microsoft-agents-storage-cosmos` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-storage-cosmos)](https://pypi.org/project/microsoft-agents-storage-cosmos/) | Extension to use CosmosDB as storage. |
65
+ | `microsoft-agents-authentication-msal` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-authentication-msal)](https://pypi.org/project/microsoft-agents-authentication-msal/) | MSAL-based authentication for Microsoft Agents. |
66
+
67
+ Additionally we provide a Copilot Studio Client, to interact with Agents created in CopilotStudio:
68
+
69
+ | Package Name | PyPI Version | Description |
70
+ |--------------|-------------|-------------|
71
+ | `microsoft-agents-copilotstudio-client` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-copilotstudio-client)](https://pypi.org/project/microsoft-agents-copilotstudio-client/) | Direct to Engine client to interact with Agents created in CopilotStudio |
72
+
73
+ ## Installation
74
+
75
+ ```bash
76
+ pip install microsoft-agents-storage-blob
77
+ ```
78
+
79
+ **Benefits:**
80
+ - ✅ No secrets in code
81
+ - ✅ Managed Identity support
82
+ - ✅ Automatic token renewal
83
+ - ✅ Fine-grained access control via Azure RBAC
84
+
85
+ ### Configuration Parameters
86
+
87
+ | Parameter | Type | Required | Description |
88
+ |-----------|------|----------|-------------|
89
+ | `container_name` | `str` | Yes | Name of the blob container to use |
90
+ | `connection_string` | `str` | No* | Storage account connection string |
91
+ | `url` | `str` | No* | Blob service URL (e.g., `https://account.blob.core.windows.net`) |
92
+ | `credential` | `TokenCredential` | No** | Azure credential for authentication |
93
+
94
+ *Either `connection_string` OR (`url` + `credential`) must be provided
95
+ **Required when using `url`
96
+
97
+
98
+ ### Azure Managed Identity
99
+
100
+ When running in Azure (App Service, Functions, Container Apps), use Managed Identity:
101
+
102
+ ```python
103
+ from azure.identity import ManagedIdentityCredential
104
+
105
+ config = BlobStorageConfig(
106
+ container_name="agent-storage",
107
+ url="https://myaccount.blob.core.windows.net",
108
+ credential=ManagedIdentityCredential()
109
+ )
110
+ ```
111
+
112
+ **Azure RBAC Roles Required:**
113
+ - `Storage Blob Data Contributor` - For read/write access
114
+ - `Storage Blob Data Reader` - For read-only access
115
+
116
+ **Benefits of switching to BlobStorage:**
117
+ - ✅ Data persists across restarts
118
+ - ✅ Scalable to millions of items
119
+ - ✅ Multi-instance support (load balancing)
120
+ - ✅ Automatic backups and geo-replication
121
+ - ✅ Built-in monitoring and diagnostics
122
+
123
+ ## Best Practices
124
+
125
+ 1. **Use Token Authentication in Production** - Avoid storing connection strings; use Managed Identity or DefaultAzureCredential
126
+ 2. **Initialize Once** - Call `storage.initialize()` during app startup, not on every request
127
+ 3. **Implement Retry Logic** - Handle transient failures with exponential backoff
128
+ 4. **Monitor Performance** - Use Azure Monitor to track storage operations
129
+ 5. **Set Lifecycle Policies** - Configure automatic cleanup of old data in Azure Portal
130
+ 6. **Use Consistent Naming** - Establish key naming conventions (e.g., `user:{id}`, `conversation:{id}`)
131
+ 7. **Batch Operations** - Read/write multiple items together when possible
132
+
133
+ ## Key Classes Reference
134
+
135
+ - **`BlobStorage`** - Main storage implementation using Azure Blob Storage
136
+ - **`BlobStorageConfig`** - Configuration settings for connection and authentication
137
+ - **`StoreItem`** - Base class for data models (inherit to create custom types)
138
+
139
+ # Quick Links
140
+
141
+ - 📦 [All SDK Packages on PyPI](https://pypi.org/search/?q=microsoft-agents)
142
+ - 📖 [Complete Documentation](https://aka.ms/agents)
143
+ - 💡 [Python Samples Repository](https://github.com/microsoft/Agents/tree/main/samples/python)
144
+ - 🐛 [Report Issues](https://github.com/microsoft/Agents-for-python/issues)
145
+
146
+ # Sample Applications
147
+
148
+ |Name|Description|README|
149
+ |----|----|----|
150
+ |Quickstart|Simplest agent|[Quickstart](https://github.com/microsoft/Agents/blob/main/samples/python/quickstart/README.md)|
151
+ |Auto Sign In|Simple OAuth agent using Graph and GitHub|[auto-signin](https://github.com/microsoft/Agents/blob/main/samples/python/auto-signin/README.md)|
152
+ |OBO Authorization|OBO flow to access a Copilot Studio Agent|[obo-authorization](https://github.com/microsoft/Agents/blob/main/samples/python/obo-authorization/README.md)|
153
+ |Semantic Kernel Integration|A weather agent built with Semantic Kernel|[semantic-kernel-multiturn](https://github.com/microsoft/Agents/blob/main/samples/python/semantic-kernel-multiturn/README.md)|
154
+ |Streaming Agent|Streams OpenAI responses|[azure-ai-streaming](https://github.com/microsoft/Agents/blob/main/samples/python/azureai-streaming/README.md)|
155
+ |Copilot Studio Client|Console app to consume a Copilot Studio Agent|[copilotstudio-client](https://github.com/microsoft/Agents/blob/main/samples/python/copilotstudio-client/README.md)|
156
+ |Cards Agent|Agent that uses rich cards to enhance conversation design |[cards](https://github.com/microsoft/Agents/blob/main/samples/python/cards/README.md)|
@@ -1,4 +1,6 @@
1
+ LICENSE
1
2
  pyproject.toml
3
+ readme.md
2
4
  setup.py
3
5
  microsoft_agents/storage/blob/__init__.py
4
6
  microsoft_agents/storage/blob/blob_storage.py
@@ -0,0 +1,3 @@
1
+ microsoft-agents-hosting-core==0.5.0
2
+ azure-core
3
+ azure-storage-blob
@@ -6,11 +6,18 @@ build-backend = "setuptools.build_meta"
6
6
  name = "microsoft-agents-storage-blob"
7
7
  dynamic = ["version", "dependencies"]
8
8
  description = "A blob storage library for Microsoft Agents"
9
+ readme = {file = "readme.md", content-type = "text/markdown"}
9
10
  authors = [{name = "Microsoft Corporation"}]
10
- requires-python = ">=3.9"
11
+ license = "MIT"
12
+ license-files = ["LICENSE"]
13
+ requires-python = ">=3.10"
11
14
  classifiers = [
12
15
  "Programming Language :: Python :: 3",
13
- "License :: OSI Approved :: MIT License",
16
+ "Programming Language :: Python :: 3.10",
17
+ "Programming Language :: Python :: 3.11",
18
+ "Programming Language :: Python :: 3.12",
19
+ "Programming Language :: Python :: 3.13",
20
+ "Programming Language :: Python :: 3.14",
14
21
  "Operating System :: OS Independent",
15
22
  ]
16
23
 
@@ -0,0 +1,133 @@
1
+ # Microsoft Agents Storage - Blob
2
+
3
+ [![PyPI version](https://img.shields.io/pypi/v/microsoft-agents-storage-blob)](https://pypi.org/project/microsoft-agents-storage-blob/)
4
+
5
+ Azure Blob Storage integration for Microsoft 365 Agents SDK. This library provides persistent storage for conversation state, user data, and custom agent information using Azure Blob Storage.
6
+
7
+ This library implements the storage interface for the Microsoft 365 Agents SDK using Azure Blob Storage as the backend. It enables your agents to persist conversation state, user preferences, and custom data across sessions. Perfect for production deployments where you need reliable, scalable cloud storage.
8
+
9
+ # What is this?
10
+ This library is part of the **Microsoft 365 Agents SDK for Python** - a comprehensive framework for building enterprise-grade conversational AI agents. The SDK enables developers to create intelligent agents that work across multiple platforms including Microsoft Teams, M365 Copilot, Copilot Studio, and web chat, with support for third-party integrations like Slack, Facebook Messenger, and Twilio.
11
+
12
+ ## Release Notes
13
+ <table style="width:100%">
14
+ <tr>
15
+ <th style="width:20%">Version</th>
16
+ <th style="width:20%">Date</th>
17
+ <th style="width:60%">Release Notes</th>
18
+ </tr>
19
+ <tr>
20
+ <td>0.5.0</td>
21
+ <td>2025-10-22</td>
22
+ <td>
23
+ <a href="https://github.com/microsoft/Agents-for-python/blob/main/changelog.md">
24
+ 0.5.0 Release Notes
25
+ </a>
26
+ </td>
27
+ </tr>
28
+ </table>
29
+
30
+ ## Packages Overview
31
+
32
+ We offer the following PyPI packages to create conversational experiences based on Agents:
33
+
34
+ | Package Name | PyPI Version | Description |
35
+ |--------------|-------------|-------------|
36
+ | `microsoft-agents-activity` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-activity)](https://pypi.org/project/microsoft-agents-activity/) | Types and validators implementing the Activity protocol spec. |
37
+ | `microsoft-agents-hosting-core` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-hosting-core)](https://pypi.org/project/microsoft-agents-hosting-core/) | Core library for Microsoft Agents hosting. |
38
+ | `microsoft-agents-hosting-aiohttp` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-hosting-aiohttp)](https://pypi.org/project/microsoft-agents-hosting-aiohttp/) | Configures aiohttp to run the Agent. |
39
+ | `microsoft-agents-hosting-teams` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-hosting-teams)](https://pypi.org/project/microsoft-agents-hosting-teams/) | Provides classes to host an Agent for Teams. |
40
+ | `microsoft-agents-storage-blob` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-storage-blob)](https://pypi.org/project/microsoft-agents-storage-blob/) | Extension to use Azure Blob as storage. |
41
+ | `microsoft-agents-storage-cosmos` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-storage-cosmos)](https://pypi.org/project/microsoft-agents-storage-cosmos/) | Extension to use CosmosDB as storage. |
42
+ | `microsoft-agents-authentication-msal` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-authentication-msal)](https://pypi.org/project/microsoft-agents-authentication-msal/) | MSAL-based authentication for Microsoft Agents. |
43
+
44
+ Additionally we provide a Copilot Studio Client, to interact with Agents created in CopilotStudio:
45
+
46
+ | Package Name | PyPI Version | Description |
47
+ |--------------|-------------|-------------|
48
+ | `microsoft-agents-copilotstudio-client` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-copilotstudio-client)](https://pypi.org/project/microsoft-agents-copilotstudio-client/) | Direct to Engine client to interact with Agents created in CopilotStudio |
49
+
50
+ ## Installation
51
+
52
+ ```bash
53
+ pip install microsoft-agents-storage-blob
54
+ ```
55
+
56
+ **Benefits:**
57
+ - ✅ No secrets in code
58
+ - ✅ Managed Identity support
59
+ - ✅ Automatic token renewal
60
+ - ✅ Fine-grained access control via Azure RBAC
61
+
62
+ ### Configuration Parameters
63
+
64
+ | Parameter | Type | Required | Description |
65
+ |-----------|------|----------|-------------|
66
+ | `container_name` | `str` | Yes | Name of the blob container to use |
67
+ | `connection_string` | `str` | No* | Storage account connection string |
68
+ | `url` | `str` | No* | Blob service URL (e.g., `https://account.blob.core.windows.net`) |
69
+ | `credential` | `TokenCredential` | No** | Azure credential for authentication |
70
+
71
+ *Either `connection_string` OR (`url` + `credential`) must be provided
72
+ **Required when using `url`
73
+
74
+
75
+ ### Azure Managed Identity
76
+
77
+ When running in Azure (App Service, Functions, Container Apps), use Managed Identity:
78
+
79
+ ```python
80
+ from azure.identity import ManagedIdentityCredential
81
+
82
+ config = BlobStorageConfig(
83
+ container_name="agent-storage",
84
+ url="https://myaccount.blob.core.windows.net",
85
+ credential=ManagedIdentityCredential()
86
+ )
87
+ ```
88
+
89
+ **Azure RBAC Roles Required:**
90
+ - `Storage Blob Data Contributor` - For read/write access
91
+ - `Storage Blob Data Reader` - For read-only access
92
+
93
+ **Benefits of switching to BlobStorage:**
94
+ - ✅ Data persists across restarts
95
+ - ✅ Scalable to millions of items
96
+ - ✅ Multi-instance support (load balancing)
97
+ - ✅ Automatic backups and geo-replication
98
+ - ✅ Built-in monitoring and diagnostics
99
+
100
+ ## Best Practices
101
+
102
+ 1. **Use Token Authentication in Production** - Avoid storing connection strings; use Managed Identity or DefaultAzureCredential
103
+ 2. **Initialize Once** - Call `storage.initialize()` during app startup, not on every request
104
+ 3. **Implement Retry Logic** - Handle transient failures with exponential backoff
105
+ 4. **Monitor Performance** - Use Azure Monitor to track storage operations
106
+ 5. **Set Lifecycle Policies** - Configure automatic cleanup of old data in Azure Portal
107
+ 6. **Use Consistent Naming** - Establish key naming conventions (e.g., `user:{id}`, `conversation:{id}`)
108
+ 7. **Batch Operations** - Read/write multiple items together when possible
109
+
110
+ ## Key Classes Reference
111
+
112
+ - **`BlobStorage`** - Main storage implementation using Azure Blob Storage
113
+ - **`BlobStorageConfig`** - Configuration settings for connection and authentication
114
+ - **`StoreItem`** - Base class for data models (inherit to create custom types)
115
+
116
+ # Quick Links
117
+
118
+ - 📦 [All SDK Packages on PyPI](https://pypi.org/search/?q=microsoft-agents)
119
+ - 📖 [Complete Documentation](https://aka.ms/agents)
120
+ - 💡 [Python Samples Repository](https://github.com/microsoft/Agents/tree/main/samples/python)
121
+ - 🐛 [Report Issues](https://github.com/microsoft/Agents-for-python/issues)
122
+
123
+ # Sample Applications
124
+
125
+ |Name|Description|README|
126
+ |----|----|----|
127
+ |Quickstart|Simplest agent|[Quickstart](https://github.com/microsoft/Agents/blob/main/samples/python/quickstart/README.md)|
128
+ |Auto Sign In|Simple OAuth agent using Graph and GitHub|[auto-signin](https://github.com/microsoft/Agents/blob/main/samples/python/auto-signin/README.md)|
129
+ |OBO Authorization|OBO flow to access a Copilot Studio Agent|[obo-authorization](https://github.com/microsoft/Agents/blob/main/samples/python/obo-authorization/README.md)|
130
+ |Semantic Kernel Integration|A weather agent built with Semantic Kernel|[semantic-kernel-multiturn](https://github.com/microsoft/Agents/blob/main/samples/python/semantic-kernel-multiturn/README.md)|
131
+ |Streaming Agent|Streams OpenAI responses|[azure-ai-streaming](https://github.com/microsoft/Agents/blob/main/samples/python/azureai-streaming/README.md)|
132
+ |Copilot Studio Client|Console app to consume a Copilot Studio Agent|[copilotstudio-client](https://github.com/microsoft/Agents/blob/main/samples/python/copilotstudio-client/README.md)|
133
+ |Cards Agent|Agent that uses rich cards to enhance conversation design |[cards](https://github.com/microsoft/Agents/blob/main/samples/python/cards/README.md)|
@@ -1,14 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: microsoft-agents-storage-blob
3
- Version: 0.4.0.dev16
4
- Summary: A blob storage library for Microsoft Agents
5
- Author: Microsoft Corporation
6
- Project-URL: Homepage, https://github.com/microsoft/Agents
7
- Classifier: Programming Language :: Python :: 3
8
- Classifier: License :: OSI Approved :: MIT License
9
- Classifier: Operating System :: OS Independent
10
- Requires-Python: >=3.9
11
- Requires-Dist: microsoft-agents-hosting-core==0.4.0.dev16
12
- Requires-Dist: azure-core
13
- Requires-Dist: azure-storage-blob
14
- Dynamic: requires-dist
@@ -1,14 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: microsoft-agents-storage-blob
3
- Version: 0.4.0.dev16
4
- Summary: A blob storage library for Microsoft Agents
5
- Author: Microsoft Corporation
6
- Project-URL: Homepage, https://github.com/microsoft/Agents
7
- Classifier: Programming Language :: Python :: 3
8
- Classifier: License :: OSI Approved :: MIT License
9
- Classifier: Operating System :: OS Independent
10
- Requires-Python: >=3.9
11
- Requires-Dist: microsoft-agents-hosting-core==0.4.0.dev16
12
- Requires-Dist: azure-core
13
- Requires-Dist: azure-storage-blob
14
- Dynamic: requires-dist
@@ -1,3 +0,0 @@
1
- microsoft-agents-hosting-core==0.4.0.dev16
2
- azure-core
3
- azure-storage-blob