d365fo-client 0.2.2__tar.gz → 0.2.3__tar.gz

{d365fo_client-0.2.2/src/d365fo_client.egg-info → d365fo_client-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: d365fo-client
-Version: 0.2.2
+Version: 0.2.3
 Summary: Microsoft Dynamics 365 Finance & Operations client
 Author-email: Muhammad Afzaal <mo@thedataguy.pro>
 License-Expression: MIT
@@ -22,6 +22,7 @@ License-File: LICENSE
 Requires-Dist: aiohttp>=3.10.0
 Requires-Dist: aiofiles>=24.1.0
 Requires-Dist: azure-identity>=1.19.0
+Requires-Dist: azure-keyvault-secrets>=4.8.0
 Requires-Dist: requests>=2.32.0
 Requires-Dist: aiosqlite>=0.19.0
 Requires-Dist: cachetools>=6.1.0
@@ -50,7 +51,7 @@ A comprehensive Python client library and MCP server for Microsoft Dynamics 365
 - 🏷️ **Label Operations V2**: Multilingual label caching with performance improvements and async support
 - 🔍 **Advanced Querying**: Support for all OData query parameters ($select, $filter, $expand, etc.)
 - ⚡ **Action Execution**: Execute bound and unbound OData actions with comprehensive parameter handling
-- 🔒 **Authentication**: Azure AD integration with default credentials and service principal support
+- 🔒 **Authentication**: Azure AD integration with default credentials, service principal, and Azure Key Vault support
 - 💾 **Intelligent Caching**: Cross-environment cache sharing with module-based version detection
 - 🌐 **Async/Await**: Modern async/await patterns with optimized session management
 - 📝 **Type Hints**: Full type annotation support with enhanced data models
@@ -58,6 +59,8 @@ A comprehensive Python client library and MCP server for Microsoft Dynamics 365
 - 🖥️ **Comprehensive CLI**: Hierarchical command-line interface for all D365 F&O operations
 - 🧪 **Multi-tier Testing**: Mock, sandbox, and live integration testing framework (17/17 tests passing)
 - 📋 **Metadata Scripts**: PowerShell and Python utilities for entity, enumeration, and action discovery
+- 🔐 **Enhanced Credential Management**: Support for Azure Key Vault and multiple credential sources
+- 📊 **Advanced Sync Management**: Session-based synchronization with detailed progress tracking
 
 ## Installation
 
@@ -73,6 +76,13 @@ uv sync  # Installs with exact dependencies from uv.lock
 
 **Note**: The package includes MCP (Model Context Protocol) dependencies by default, enabling AI assistant integration. Both `d365fo-client` CLI and `d365fo-mcp-server` commands will be available after installation.
 
+**Breaking Change in v0.2.3**: Environment variable names have been updated for consistency:
+- `AZURE_CLIENT_ID` → `D365FO_CLIENT_ID`
+- `AZURE_CLIENT_SECRET` → `D365FO_CLIENT_SECRET`  
+- `AZURE_TENANT_ID` → `D365FO_TENANT_ID`
+
+Please update your environment variables accordingly when upgrading.
+
 ## Quick Start
 
 ## Command Line Interface (CLI)
@@ -158,9 +168,9 @@ profiles:
     
   development:
     base_url: "https://dev.dynamics.com" 
-    client_id: "${AZURE_CLIENT_ID}"
-    client_secret: "${AZURE_CLIENT_SECRET}"
-    tenant_id: "${AZURE_TENANT_ID}"
+    client_id: "${D365FO_CLIENT_ID}"
+    client_secret: "${D365FO_CLIENT_SECRET}"
+    tenant_id: "${D365FO_TENANT_ID}"
     use_cache_first: true
 
 default_profile: "development"
@@ -262,7 +272,14 @@ config = FOClientConfig(
     use_default_credentials=False
 )
 
-# Option 3: With custom settings
+# Option 3: Azure Key Vault integration (New in v0.2.3)
+config = FOClientConfig(
+    base_url="https://your-fo-environment.dynamics.com",
+    credential_source="keyvault",  # Use Azure Key Vault for credentials
+    keyvault_url="https://your-keyvault.vault.azure.net/"
+)
+
+# Option 4: With custom settings
 config = FOClientConfig(
     base_url="https://your-fo-environment.dynamics.com",
     use_default_credentials=True,
@@ -462,7 +479,9 @@ d365fo-client/
 │       ├── metadata.py          # Legacy metadata operations
 │       ├── metadata_api.py      # Metadata API client
 │       ├── metadata_cache.py    # Metadata caching layer V2
-│       ├── metadata_sync.py     # Metadata synchronization V2
+│       ├── metadata_sync.py     # Metadata synchronization V2 with session management
+│       ├── sync_session.py      # Enhanced sync session management (New in v0.2.3)
+│       ├── credential_manager.py # Credential source management (New in v0.2.3)
 │       ├── labels.py            # Label operations V2
 │       ├── profiles.py          # Profile data models
 │       ├── profile_manager.py   # Profile management
@@ -519,6 +538,8 @@ d365fo-client/
 | `client_secret` | str | None | Azure AD client secret |
 | `tenant_id` | str | None | Azure AD tenant ID |
 | `use_default_credentials` | bool | True | Use Azure Default Credential |
+| `credential_source` | str | "environment" | Credential source: "environment", "keyvault" |
+| `keyvault_url` | str | None | Azure Key Vault URL for credential storage |
 | `verify_ssl` | bool | False | Verify SSL certificates |
 | `timeout` | int | 30 | Request timeout in seconds |
 | `metadata_cache_dir` | str | Platform-specific user cache | Metadata cache directory |
@@ -619,9 +640,9 @@ cp tests/integration/.env.template tests/integration/.env
 # Edit .env file with your settings:
 INTEGRATION_TEST_LEVEL=sandbox
 D365FO_SANDBOX_BASE_URL=https://your-test.dynamics.com
-AZURE_CLIENT_ID=your-client-id
-AZURE_CLIENT_SECRET=your-client-secret
-AZURE_TENANT_ID=your-tenant-id
+D365FO_CLIENT_ID=your-client-id
+D365FO_CLIENT_SECRET=your-client-secret
+D365FO_TENANT_ID=your-tenant-id
 ```
 
 #### Available Commands
@@ -707,9 +728,9 @@ pip install d365fo-client
 
 # Set up environment variables
 export D365FO_BASE_URL="https://your-environment.dynamics.com"
-export AZURE_CLIENT_ID="your-client-id"          # Optional with default credentials
-export AZURE_CLIENT_SECRET="your-client-secret"  # Optional with default credentials  
-export AZURE_TENANT_ID="your-tenant-id"          # Optional with default credentials
+export D365FO_CLIENT_ID="your-client-id"          # Optional with default credentials
+export D365FO_CLIENT_SECRET="your-client-secret"  # Optional with default credentials  
+export D365FO_TENANT_ID="your-tenant-id"          # Optional with default credentials
 
 # Start the MCP server
 d365fo-mcp-server
@@ -857,9 +878,19 @@ For service principal authentication:
 
 ```bash
 export D365FO_BASE_URL="https://your-environment.dynamics.com"
-export AZURE_CLIENT_ID="your-client-id"
-export AZURE_CLIENT_SECRET="your-client-secret"
-export AZURE_TENANT_ID="your-tenant-id"
+export D365FO_CLIENT_ID="your-client-id"
+export D365FO_CLIENT_SECRET="your-client-secret"
+export D365FO_TENANT_ID="your-tenant-id"
+d365fo-mcp-server
+```
+
+#### Azure Key Vault Integration (New in v0.2.3)
+For secure credential storage using Azure Key Vault:
+
+```bash
+export D365FO_BASE_URL="https://your-environment.dynamics.com"
+export D365FO_CREDENTIAL_SOURCE="keyvault"
+export D365FO_KEYVAULT_URL="https://your-keyvault.vault.azure.net/"
 d365fo-mcp-server
 ```
 
@@ -1032,7 +1063,7 @@ tail -f ~/.d365fo-mcp/logs/mcp-server.log
 az account show
 
 # Test with explicit credentials
-export AZURE_CLIENT_ID="your-client-id"
+export D365FO_CLIENT_ID="your-client-id"
 # ... set other variables
 d365fo-mcp-server
 ```

{d365fo_client-0.2.2 → d365fo_client-0.2.3}/README.md

@@ -9,7 +9,7 @@ A comprehensive Python client library and MCP server for Microsoft Dynamics 365
 - 🏷️ **Label Operations V2**: Multilingual label caching with performance improvements and async support
 - 🔍 **Advanced Querying**: Support for all OData query parameters ($select, $filter, $expand, etc.)
 - ⚡ **Action Execution**: Execute bound and unbound OData actions with comprehensive parameter handling
-- 🔒 **Authentication**: Azure AD integration with default credentials and service principal support
+- 🔒 **Authentication**: Azure AD integration with default credentials, service principal, and Azure Key Vault support
 - 💾 **Intelligent Caching**: Cross-environment cache sharing with module-based version detection
 - 🌐 **Async/Await**: Modern async/await patterns with optimized session management
 - 📝 **Type Hints**: Full type annotation support with enhanced data models
@@ -17,6 +17,8 @@ A comprehensive Python client library and MCP server for Microsoft Dynamics 365
 - 🖥️ **Comprehensive CLI**: Hierarchical command-line interface for all D365 F&O operations
 - 🧪 **Multi-tier Testing**: Mock, sandbox, and live integration testing framework (17/17 tests passing)
 - 📋 **Metadata Scripts**: PowerShell and Python utilities for entity, enumeration, and action discovery
+- 🔐 **Enhanced Credential Management**: Support for Azure Key Vault and multiple credential sources
+- 📊 **Advanced Sync Management**: Session-based synchronization with detailed progress tracking
 
 ## Installation
 
@@ -32,6 +34,13 @@ uv sync  # Installs with exact dependencies from uv.lock
 
 **Note**: The package includes MCP (Model Context Protocol) dependencies by default, enabling AI assistant integration. Both `d365fo-client` CLI and `d365fo-mcp-server` commands will be available after installation.
 
+**Breaking Change in v0.2.3**: Environment variable names have been updated for consistency:
+- `AZURE_CLIENT_ID` → `D365FO_CLIENT_ID`
+- `AZURE_CLIENT_SECRET` → `D365FO_CLIENT_SECRET`  
+- `AZURE_TENANT_ID` → `D365FO_TENANT_ID`
+
+Please update your environment variables accordingly when upgrading.
+
 ## Quick Start
 
 ## Command Line Interface (CLI)
@@ -117,9 +126,9 @@ profiles:
     
   development:
     base_url: "https://dev.dynamics.com" 
-    client_id: "${AZURE_CLIENT_ID}"
-    client_secret: "${AZURE_CLIENT_SECRET}"
-    tenant_id: "${AZURE_TENANT_ID}"
+    client_id: "${D365FO_CLIENT_ID}"
+    client_secret: "${D365FO_CLIENT_SECRET}"
+    tenant_id: "${D365FO_TENANT_ID}"
     use_cache_first: true
 
 default_profile: "development"
@@ -221,7 +230,14 @@ config = FOClientConfig(
     use_default_credentials=False
 )
 
-# Option 3: With custom settings
+# Option 3: Azure Key Vault integration (New in v0.2.3)
+config = FOClientConfig(
+    base_url="https://your-fo-environment.dynamics.com",
+    credential_source="keyvault",  # Use Azure Key Vault for credentials
+    keyvault_url="https://your-keyvault.vault.azure.net/"
+)
+
+# Option 4: With custom settings
 config = FOClientConfig(
     base_url="https://your-fo-environment.dynamics.com",
     use_default_credentials=True,
@@ -421,7 +437,9 @@ d365fo-client/
 │       ├── metadata.py          # Legacy metadata operations
 │       ├── metadata_api.py      # Metadata API client
 │       ├── metadata_cache.py    # Metadata caching layer V2
-│       ├── metadata_sync.py     # Metadata synchronization V2
+│       ├── metadata_sync.py     # Metadata synchronization V2 with session management
+│       ├── sync_session.py      # Enhanced sync session management (New in v0.2.3)
+│       ├── credential_manager.py # Credential source management (New in v0.2.3)
 │       ├── labels.py            # Label operations V2
 │       ├── profiles.py          # Profile data models
 │       ├── profile_manager.py   # Profile management
@@ -478,6 +496,8 @@ d365fo-client/
 | `client_secret` | str | None | Azure AD client secret |
 | `tenant_id` | str | None | Azure AD tenant ID |
 | `use_default_credentials` | bool | True | Use Azure Default Credential |
+| `credential_source` | str | "environment" | Credential source: "environment", "keyvault" |
+| `keyvault_url` | str | None | Azure Key Vault URL for credential storage |
 | `verify_ssl` | bool | False | Verify SSL certificates |
 | `timeout` | int | 30 | Request timeout in seconds |
 | `metadata_cache_dir` | str | Platform-specific user cache | Metadata cache directory |
@@ -578,9 +598,9 @@ cp tests/integration/.env.template tests/integration/.env
 # Edit .env file with your settings:
 INTEGRATION_TEST_LEVEL=sandbox
 D365FO_SANDBOX_BASE_URL=https://your-test.dynamics.com
-AZURE_CLIENT_ID=your-client-id
-AZURE_CLIENT_SECRET=your-client-secret
-AZURE_TENANT_ID=your-tenant-id
+D365FO_CLIENT_ID=your-client-id
+D365FO_CLIENT_SECRET=your-client-secret
+D365FO_TENANT_ID=your-tenant-id
 ```
 
 #### Available Commands
@@ -666,9 +686,9 @@ pip install d365fo-client
 
 # Set up environment variables
 export D365FO_BASE_URL="https://your-environment.dynamics.com"
-export AZURE_CLIENT_ID="your-client-id"          # Optional with default credentials
-export AZURE_CLIENT_SECRET="your-client-secret"  # Optional with default credentials  
-export AZURE_TENANT_ID="your-tenant-id"          # Optional with default credentials
+export D365FO_CLIENT_ID="your-client-id"          # Optional with default credentials
+export D365FO_CLIENT_SECRET="your-client-secret"  # Optional with default credentials  
+export D365FO_TENANT_ID="your-tenant-id"          # Optional with default credentials
 
 # Start the MCP server
 d365fo-mcp-server
@@ -816,9 +836,19 @@ For service principal authentication:
 
 ```bash
 export D365FO_BASE_URL="https://your-environment.dynamics.com"
-export AZURE_CLIENT_ID="your-client-id"
-export AZURE_CLIENT_SECRET="your-client-secret"
-export AZURE_TENANT_ID="your-tenant-id"
+export D365FO_CLIENT_ID="your-client-id"
+export D365FO_CLIENT_SECRET="your-client-secret"
+export D365FO_TENANT_ID="your-tenant-id"
+d365fo-mcp-server
+```
+
+#### Azure Key Vault Integration (New in v0.2.3)
+For secure credential storage using Azure Key Vault:
+
+```bash
+export D365FO_BASE_URL="https://your-environment.dynamics.com"
+export D365FO_CREDENTIAL_SOURCE="keyvault"
+export D365FO_KEYVAULT_URL="https://your-keyvault.vault.azure.net/"
 d365fo-mcp-server
 ```
 
@@ -991,7 +1021,7 @@ tail -f ~/.d365fo-mcp/logs/mcp-server.log
 az account show
 
 # Test with explicit credentials
-export AZURE_CLIENT_ID="your-client-id"
+export D365FO_CLIENT_ID="your-client-id"
 # ... set other variables
 d365fo-mcp-server
 ```

{d365fo_client-0.2.2 → d365fo_client-0.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "d365fo-client"
-version = "0.2.2"
+version = "0.2.3"
 description = "Microsoft Dynamics 365 Finance & Operations client"
 readme = "README.md"
 license = "MIT"
@@ -10,6 +10,7 @@ dependencies = [
     "aiohttp>=3.10.0",
     "aiofiles>=24.1.0",
     "azure-identity>=1.19.0",
+    "azure-keyvault-secrets>=4.8.0",
     "requests>=2.32.0",
     "aiosqlite>=0.19.0",
     "cachetools>=6.1.0",

{d365fo_client-0.2.2 → d365fo_client-0.2.3}/src/d365fo_client/auth.py

@@ -5,6 +5,7 @@ from typing import Optional
 
 from azure.identity import ClientSecretCredential, DefaultAzureCredential
 
+from .credential_sources import CredentialManager, CredentialSource
 from .models import FOClientConfig
 
 
@@ -20,25 +21,46 @@ class AuthenticationManager:
         self.config = config
         self._token = None
         self._token_expires = None
-        self.credential = self._setup_credentials()
-
-    def _setup_credentials(self):
-        """Setup authentication credentials"""
-        if self.config.use_default_credentials:
-            return DefaultAzureCredential()
-        elif (
+        self._credential_manager = CredentialManager()
+        self.credential = None  # Will be set by _setup_credentials
+
+    async def _setup_credentials(self):
+        """Setup authentication credentials with support for credential sources"""
+        
+        # Check if credential source is specified in config
+        credential_source = getattr(self.config, 'credential_source', None)
+        
+        if credential_source is not None:
+            # Use credential source to get credentials
+            try:
+                client_id, client_secret, tenant_id = await self._credential_manager.get_credentials(credential_source)
+                self.credential = ClientSecretCredential(
+                    tenant_id=tenant_id,
+                    client_id=client_id,
+                    client_secret=client_secret,
+                )
+                return
+            except Exception as e:
+                raise ValueError(f"Failed to setup credentials from source: {e}")
+        
+        
+        # Fallback to existing logic for backward compatibility
+  
+        if (
             self.config.client_id
             and self.config.client_secret
             and self.config.tenant_id
         ):
-            return ClientSecretCredential(
+            self.credential = ClientSecretCredential(
                 tenant_id=self.config.tenant_id,
                 client_id=self.config.client_id,
                 client_secret=self.config.client_secret,
             )
+        elif self.config.use_default_credentials:
+            self.credential = DefaultAzureCredential()
         else:
             raise ValueError(
-                "Must provide either use_default_credentials=True or client credentials"
+                "Must provide either use_default_credentials=True, client credentials, or credential_source"
             )
 
     async def get_token(self) -> str:
@@ -51,6 +73,10 @@ class AuthenticationManager:
         if self._is_localhost():
             return "mock-token-for-localhost"
 
+        # Initialize credentials if not already set
+        if self.credential is None:
+            await self._setup_credentials()
+
         if (
             self._token
             and self._token_expires
@@ -91,3 +117,16 @@ class AuthenticationManager:
         """Invalidate cached token to force refresh"""
         self._token = None
         self._token_expires = None
+
+    async def invalidate_credentials(self):
+        """Invalidate cached credentials and token to force full refresh"""
+        self.invalidate_token()
+        self.credential = None
+        if hasattr(self, '_credential_manager'):
+            self._credential_manager.clear_cache()
+
+    def get_credential_cache_stats(self) -> dict:
+        """Get credential cache statistics for debugging"""
+        if hasattr(self, '_credential_manager'):
+            return self._credential_manager.get_cache_stats()
+        return {"total_cached": 0, "expired": 0, "active": 0}

{d365fo_client-0.2.2 → d365fo_client-0.2.3}/src/d365fo_client/client.py

@@ -11,6 +11,7 @@ from .exceptions import FOClientError
 from .labels import LabelOperations, resolve_labels_generic
 from .metadata_api import MetadataAPIOperations
 from .metadata_v2 import MetadataCacheV2, SmartSyncManagerV2
+from .metadata_v2.sync_session_manager import SyncSessionManager
 from .models import (
     ActionInfo,
     DataEntityInfo,
@@ -58,6 +59,7 @@ class FOClient:
         # Initialize new metadata cache and sync components
         self.metadata_cache = None
         self.sync_manager = None
+        self._sync_session_manager = None
         self._metadata_initialized = False
         self._background_sync_task = None
 
@@ -83,6 +85,10 @@ class FOClient:
 
         await self.session_manager.close()
 
+    
+    async def initialize_metadata(self):
+        await self._ensure_metadata_initialized()
+
     async def _ensure_metadata_initialized(self):
         """Ensure metadata cache and sync manager are initialized"""
         if not self._metadata_initialized and self.config.enable_metadata_cache:
@@ -104,6 +110,9 @@ class FOClient:
                     self.metadata_cache, self.metadata_api_ops
                 )
 
+                # Initialize sync message with session
+                self._sync_session_manager = SyncSessionManager(self.metadata_cache, self.metadata_api_ops)
+
                 self._metadata_initialized = True
                 self.logger.debug("Metadata cache v2 with label caching initialized")
 
@@ -144,18 +153,9 @@ class FOClient:
                 f"Starting background metadata sync for version {global_version_id}"
             )
 
-            # Use self as the fo_client for sync - SmartSyncManagerV2 expects a client with metadata API operations
-            result = await self.sync_manager.sync_metadata(global_version_id)
-
-            if result.success:
-                self.logger.info(
-                    f"Background sync completed: "
-                    f"{result.entity_count} entities, "
-                    f"{result.enumeration_count} enumerations, "
-                    f"{result.duration_ms:.2f}ms"
-                )
-            else:
-                self.logger.warning(f"Background sync failed: {result.error}")
+ 
+            self.sync_session_manager.start_sync_session(global_version_id=global_version_id,initiated_by="background_task")
+            
 
         except Exception as e:
             self.logger.error(f"Background sync error: {e}")
@@ -172,6 +172,27 @@ class FOClient:
             and not self._background_sync_task.done()
         )
 
+    @property
+    def sync_session_manager(self) -> SyncSessionManager:
+        """Get sync session manager (lazy initialization).
+        
+        Returns:
+            SyncSessionManager instance for enhanced sync progress tracking
+            
+        Raises:
+            RuntimeError: If metadata cache is not initialized
+        """
+        if self._sync_session_manager is None:
+            if not self.metadata_cache:
+                raise RuntimeError("Metadata cache must be initialized before accessing sync session manager")
+            
+            self._sync_session_manager = SyncSessionManager(
+                cache=self.metadata_cache,
+                metadata_api=self.metadata_api_ops
+            )
+        
+        return self._sync_session_manager
+
     async def _get_from_cache_first(
         self,
         cache_method,
@@ -687,17 +708,16 @@ class FOClient:
 
     async def get_data_entities(
         self, options: Optional[QueryOptions] = None
-    ) -> List[DataEntityInfo]:
-        """Get data entities - updated to return list for v2 sync compatibility
+    ) -> Dict[str, Any]:
+        """Get data entities from DataEntities metadata endpoint
 
         Args:
-            options: OData query options (ignored for now)
+            options: OData query options
 
         Returns:
-            List of DataEntityInfo objects
+            Response containing data entities
         """
-        # For sync manager compatibility, return list of DataEntityInfo objects
-        return await self.metadata_api_ops.search_data_entities("")  # Get all entities
+        return await self.metadata_api_ops.get_data_entities(options)
 
     async def get_data_entities_raw(
         self, options: Optional[QueryOptions] = None
@@ -934,7 +954,7 @@ class FOClient:
         Returns:
             Response containing public enumerations
         """
-        self._ensure_metadata_initialized()
+        await self._ensure_metadata_initialized()
 
         return await self.metadata_api_ops.get_public_enumerations(options)
 
@@ -1188,7 +1208,7 @@ class FOClient:
                     "advanced_cache_enabled": True,
                     "cache_v2_enabled": True,
                     "cache_initialized": self._metadata_initialized,
-                    "sync_manager_available": self.sync_manager is not None,
+                    "sync_manager_available": self.sync_manager is not None or self._sync_session_manager is not None,
                     "background_sync_running": self._is_background_sync_running(),
                     "statistics": stats,
                 }