microsoft-agents-storage-cosmos 0.4.0.dev18__py3-none-any.whl → 0.5.0__py3-none-any.whl

microsoft_agents/storage/cosmos/cosmos_db_storage.py

@@ -2,7 +2,7 @@
 # Licensed under the MIT License.
 
 from typing import TypeVar, Union
-from threading import Lock
+import asyncio
 
 from azure.cosmos import (
     documents,
@@ -49,7 +49,7 @@ class CosmosDBStorage(AsyncStorageBase):
         self._container: ContainerProxy = None
         self._compatability_mode_partition_key: bool = False
         # Lock used for synchronizing container creation
-        self._lock: Lock = Lock()
+        self._lock: asyncio.Lock = asyncio.Lock()
 
     def _create_client(self) -> CosmosClient:
         if self._config.url:
@@ -164,8 +164,8 @@ class CosmosDBStorage(AsyncStorageBase):
 
     async def initialize(self) -> None:
         if not self._container:
-            with self._lock:
-                # in case another thread attempted to initialize just before acquiring the lock
+            async with self._lock:
+                # in case another async task attempted to initialize just before acquiring the lock
                 if self._container:
                     return
 

microsoft_agents/storage/cosmos/cosmos_db_storage_config.py

@@ -42,7 +42,8 @@ class CosmosDBStorageConfig:
         """
         config_file: str = kwargs.get("filename", "")
         if config_file:
-            kwargs = json.load(open(config_file))
+            with open(config_file) as f:
+                kwargs = json.load(f)
         self.cosmos_db_endpoint: str = cosmos_db_endpoint or kwargs.get(
             "cosmos_db_endpoint", ""
         )

microsoft_agents_storage_cosmos-0.5.0.dist-info/METADATA

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: microsoft-agents-storage-cosmos
+Version: 0.5.0
+Summary: A Cosmos DB storage library for Microsoft Agents
+Author: Microsoft Corporation
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/microsoft/Agents
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: microsoft-agents-hosting-core==0.5.0
+Requires-Dist: azure-core
+Requires-Dist: azure-cosmos
+Dynamic: license-file
+Dynamic: requires-dist
+
+# Microsoft Agents Storage - Cosmos DB
+
+[![PyPI version](https://img.shields.io/pypi/v/microsoft-agents-storage-cosmos)](https://pypi.org/project/microsoft-agents-storage-cosmos/)
+
+Azure Cosmos DB storage integration for Microsoft 365 Agents SDK. This library provides enterprise-grade persistent storage for conversation state, user data, and custom agent information using Azure Cosmos DB's globally distributed, multi-model database service.
+
+This library implements the storage interface for the Microsoft 365 Agents SDK using Azure Cosmos DB as the backend. It provides automatic partitioning, global distribution, and low-latency access to your agent data. Perfect for production deployments requiring high availability, scalability, and multi-region support.
+
+# What is this?
+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.
+
+## Release Notes
+<table style="width:100%">
+  <tr>
+    <th style="width:20%">Version</th>
+    <th style="width:20%">Date</th>
+    <th style="width:60%">Release Notes</th>
+  </tr>
+  <tr>
+    <td>0.5.0</td>
+    <td>2025-10-22</td>
+    <td>
+      <a href="https://github.com/microsoft/Agents-for-python/blob/main/changelog.md">
+        0.5.0 Release Notes
+      </a>
+    </td>
+  </tr>
+</table>
+
+## Packages Overview
+
+We offer the following PyPI packages to create conversational experiences based on Agents:
+
+| Package Name | PyPI Version | Description |
+|--------------|-------------|-------------|
+| `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. |
+| `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. |
+| `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. |
+| `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. |
+| `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. |
+| `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. |
+| `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. |
+
+Additionally we provide a Copilot Studio Client, to interact with Agents created in CopilotStudio:
+
+| Package Name | PyPI Version | Description |
+|--------------|-------------|-------------|
+| `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 |
+
+**Why Cosmos DB?**
+- 🌍 Global distribution with multi-region writes
+- ⚡ Single-digit millisecond latency
+- 📈 Automatic and instant scalability
+- 🔄 Multiple consistency models
+- 💪 99.999% availability SLA
+
+## Installation
+
+```bash
+pip install microsoft-agents-storage-cosmos
+```
+
+
+## Environment Setup
+
+### Local Development with Cosmos DB Emulator
+
+Install and run the Azure Cosmos DB Emulator for local testing:
+
+**Download:** [Azure Cosmos DB Emulator](https://docs.microsoft.com/azure/cosmos-db/local-emulator)
+
+
+## Best Practices
+
+1. **Use Managed Identity in Production** - Avoid storing auth keys in code or environment variables
+2. **Initialize Once** - Call `storage.initialize()` during app startup, not per request
+3. **Batch Operations** - Read/write multiple items together when possible
+4. **Monitor RU Consumption** - Use Azure Monitor to track Request Units usage
+5. **Set Appropriate Throughput** - Start with 400 RU/s, scale up based on metrics
+6. **Use Session Consistency** - Default consistency level for most scenarios
+7. **Implement Retry Logic** - Handle transient failures with exponential backoff
+8. **Partition Wisely** - Current implementation uses `/id` partitioning (automatic)
+9. **Enable Diagnostics** - Configure Azure diagnostic logs for troubleshooting
+10. **Test with Emulator** - Use local emulator for development and testing
+
+## Key Classes Reference
+
+- **`CosmosDBStorage`** - Main storage implementation using Azure Cosmos DB
+- **`CosmosDBStorageConfig`** - Configuration settings for connection and behavior
+- **`StoreItem`** - Base class for data models (inherit to create custom types)
+
+# Quick Links
+
+- 📦 [All SDK Packages on PyPI](https://pypi.org/search/?q=microsoft-agents)
+- 📖 [Complete Documentation](https://aka.ms/agents)
+- 💡 [Python Samples Repository](https://github.com/microsoft/Agents/tree/main/samples/python)
+- 🐛 [Report Issues](https://github.com/microsoft/Agents-for-python/issues)
+
+# Sample Applications
+
+|Name|Description|README|
+|----|----|----|
+|Quickstart|Simplest agent|[Quickstart](https://github.com/microsoft/Agents/blob/main/samples/python/quickstart/README.md)|
+|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)|
+|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)|
+|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)|
+|Streaming Agent|Streams OpenAI responses|[azure-ai-streaming](https://github.com/microsoft/Agents/blob/main/samples/python/azureai-streaming/README.md)|
+|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)|
+|Cards Agent|Agent that uses rich cards to enhance conversation design |[cards](https://github.com/microsoft/Agents/blob/main/samples/python/cards/README.md)|

microsoft_agents_storage_cosmos-0.5.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+microsoft_agents/storage/cosmos/__init__.py,sha256=2JVNhbohUB-Pm8LmgagHQH3vlEgljpUzbfPhdOS-rCQ,174
+microsoft_agents/storage/cosmos/cosmos_db_storage.py,sha256=yqU51Ji0wceuHKtppa2oQDrBqXI0LFi69OPGDe2mh8o,6529
+microsoft_agents/storage/cosmos/cosmos_db_storage_config.py,sha256=a2-s7Kj5RbYnVU0CyB60dEG501-oRcSXZTQ--_QlISA,4143
+microsoft_agents/storage/cosmos/key_ops.py,sha256=2wnSdSpKzwoCvw4giNn68pBDOa1Gc1jyvEhk2tc_gPQ,1747
+microsoft_agents_storage_cosmos-0.5.0.dist-info/licenses/LICENSE,sha256=ws_MuBL-SCEBqPBFl9_FqZkaaydIJmxHrJG2parhU4M,1141
+microsoft_agents_storage_cosmos-0.5.0.dist-info/METADATA,sha256=u1ByfBV70g-7zaj18gdV-jh075E3_5j2db0WpubfAqE,7774
+microsoft_agents_storage_cosmos-0.5.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+microsoft_agents_storage_cosmos-0.5.0.dist-info/top_level.txt,sha256=lWKcT4v6fTA_NgsuHdNvuMjSrkiBMXohn64ApY7Xi8A,17
+microsoft_agents_storage_cosmos-0.5.0.dist-info/RECORD,,

microsoft_agents_storage_cosmos-0.5.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

microsoft_agents_storage_cosmos-0.4.0.dev18.dist-info/METADATA

@@ -1,14 +0,0 @@
-Metadata-Version: 2.4
-Name: microsoft-agents-storage-cosmos
-Version: 0.4.0.dev18
-Summary: A Cosmos DB storage library for Microsoft Agents
-Author: Microsoft Corporation
-Project-URL: Homepage, https://github.com/microsoft/Agents
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
-Requires-Dist: microsoft-agents-hosting-core==0.4.0.dev18
-Requires-Dist: azure-core
-Requires-Dist: azure-cosmos
-Dynamic: requires-dist

microsoft_agents_storage_cosmos-0.4.0.dev18.dist-info/RECORD

@@ -1,8 +0,0 @@
-microsoft_agents/storage/cosmos/__init__.py,sha256=2JVNhbohUB-Pm8LmgagHQH3vlEgljpUzbfPhdOS-rCQ,174
-microsoft_agents/storage/cosmos/cosmos_db_storage.py,sha256=jcyLaaGtnvbjAjjVoNygQQy96Qhj9a8wURU50XVMHUk,6515
-microsoft_agents/storage/cosmos/cosmos_db_storage_config.py,sha256=JS2dQnwCjR1XfEIeJnQGJHhMwxeBmUNwWANqRte10N4,4114
-microsoft_agents/storage/cosmos/key_ops.py,sha256=2wnSdSpKzwoCvw4giNn68pBDOa1Gc1jyvEhk2tc_gPQ,1747
-microsoft_agents_storage_cosmos-0.4.0.dev18.dist-info/METADATA,sha256=-oz1aTexCX_Nrcj-QEEN3JQvwtp791BBpqy9tpZpH_U,532
-microsoft_agents_storage_cosmos-0.4.0.dev18.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-microsoft_agents_storage_cosmos-0.4.0.dev18.dist-info/top_level.txt,sha256=lWKcT4v6fTA_NgsuHdNvuMjSrkiBMXohn64ApY7Xi8A,17
-microsoft_agents_storage_cosmos-0.4.0.dev18.dist-info/RECORD,,