pvw-cli 1.0.11__py3-none-any.whl → 1.0.12__py3-none-any.whl

purviewcli/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.0.11"
+__version__ = "1.0.12"
 
 # Import main client modules
 from .client import *

purviewcli/cli/unified_catalog.py

@@ -51,8 +51,7 @@ def domain():
     "--type",
     required=False,
     default="FunctionalUnit",
-    type=click.Choice(["FunctionalUnit", "BusinessUnit", "Department"]),
-    help="Type of governance domain",
+    help="Type of governance domain (default: FunctionalUnit). Note: UC API currently only accepts 'FunctionalUnit'.",
 )
 @click.option(
     "--owner-id",
@@ -67,19 +66,46 @@ def domain():
     type=click.Choice(["Draft", "Published", "Archived"]),
     help="Status of the governance domain",
 )
-def create(name, description, type, owner_id, status):
+@click.option(
+    "--parent-id",
+    required=False,
+    help="Parent governance domain ID (create as subdomain under this domain)",
+)
+@click.option(
+    "--payload-file",
+    required=False,
+    type=click.Path(exists=True),
+    help="Optional JSON payload file to use for creating the domain (overrides flags if provided)",
+)
+def create(name, description, type, owner_id, status, parent_id, payload_file):
     """Create a new governance domain."""
     try:
         client = UnifiedCatalogClient()
 
         # Build args dictionary in Purview CLI format
-        args = {
-            "--name": [name],
-            "--description": [description],
-            "--type": [type],
-            "--status": [status],
-        }
-
+        # If payload-file is provided we will let the client read the file directly
+        # otherwise build args from individual flags.
+        args = {}
+        # Note: click will pass None for owner_id if not provided, but multiple=True returns ()
+        # We'll only include values if payload-file not used.
+        if locals().get('payload_file'):
+            args = {"--payloadFile": locals().get('payload_file')}
+        else:
+            args = {
+                "--name": [name],
+                "--description": [description],
+                "--type": [type],
+                "--status": [status],
+            }
+            if owner_id:
+                args["--owner-id"] = list(owner_id)
+            # include parent id if provided
+            parent_id = locals().get('parent_id')
+            if parent_id:
+                # use a consistent arg name for client lookup
+                args["--parent-domain-id"] = [parent_id]
+
+        # Call the client to create the governance domain
         result = client.create_governance_domain(args)
 
         if not result:
@@ -973,6 +999,84 @@ def delete(term_id, force):
         console.print(f"[red]ERROR:[/red] {str(e)}")
 
 
+@term.command()
+@click.option("--term-id", required=True, help="ID of the glossary term to update")
+@click.option("--name", required=False, help="Name of the glossary term")
+@click.option("--description", required=False, help="Rich text description of the term")
+@click.option("--domain-id", required=False, help="Governance domain ID")
+@click.option(
+    "--status",
+    required=False,
+    type=click.Choice(["Draft", "Published", "Archived"]),
+    help="Status of the term",
+)
+@click.option(
+    "--acronym",
+    required=False,
+    help="Acronyms for the term (can be specified multiple times, replaces existing)",
+    multiple=True,
+)
+@click.option(
+    "--owner-id",
+    required=False,
+    help="Owner Entra ID (can be specified multiple times, replaces existing)",
+    multiple=True,
+)
+@click.option("--resource-name", required=False, help="Resource name for additional reading (can be specified multiple times, replaces existing)", multiple=True)
+@click.option("--resource-url", required=False, help="Resource URL for additional reading (can be specified multiple times, replaces existing)", multiple=True)
+@click.option("--add-acronym", required=False, help="Add acronym to existing ones (can be specified multiple times)", multiple=True)
+@click.option("--add-owner-id", required=False, help="Add owner to existing ones (can be specified multiple times)", multiple=True)
+def update(term_id, name, description, domain_id, status, acronym, owner_id, resource_name, resource_url, add_acronym, add_owner_id):
+    """Update an existing Unified Catalog term."""
+    try:
+        client = UnifiedCatalogClient()
+
+        # Build args dictionary - only include provided values
+        args = {"--term-id": [term_id]}
+        
+        if name:
+            args["--name"] = [name]
+        if description is not None:  # Allow empty string
+            args["--description"] = [description]
+        if domain_id:
+            args["--governance-domain-id"] = [domain_id]
+        if status:
+            args["--status"] = [status]
+        
+        # Handle acronyms - either replace or add
+        if acronym:
+            args["--acronym"] = list(acronym)
+        elif add_acronym:
+            args["--add-acronym"] = list(add_acronym)
+        
+        # Handle owners - either replace or add
+        if owner_id:
+            args["--owner-id"] = list(owner_id)
+        elif add_owner_id:
+            args["--add-owner-id"] = list(add_owner_id)
+        
+        # Handle resources
+        if resource_name:
+            args["--resource-name"] = list(resource_name)
+        if resource_url:
+            args["--resource-url"] = list(resource_url)
+
+        result = client.update_term(args)
+
+        if not result:
+            console.print("[red]ERROR:[/red] No response received")
+            return
+        if isinstance(result, dict) and "error" in result:
+            console.print(f"[red]ERROR:[/red] {result.get('error', 'Unknown error')}")
+            return
+
+        console.print(f"[green]✅ SUCCESS:[/green] Updated glossary term '{term_id}'")
+        console.print(json.dumps(result, indent=2))
+
+    except Exception as e:
+        console.print(f"[red]ERROR:[/red] {str(e)}")
+
+
 # ========================================
 # OBJECTIVES AND KEY RESULTS (OKRs)
 # ========================================

purviewcli/client/_unified_catalog.py

@@ -39,12 +39,22 @@ class UnifiedCatalogClient(Endpoint):
         """Create a new governance domain."""
         self.method = "POST"
         self.endpoint = "/datagovernance/catalog/businessdomains"
-        self.payload = get_json(args, "--payloadFile") or {
-            "name": args.get("--name", [""])[0],
-            "description": args.get("--description", [""])[0],
-            "type": args.get("--type", ["FunctionalUnit"])[0],
-            "status": args.get("--status", ["Draft"])[0],
-        }
+        # Allow payload file to fully control creation; otherwise build payload from flags
+        payload = get_json(args, "--payloadFile")
+        if not payload:
+            payload = {
+                "name": args.get("--name", [""])[0],
+                "description": args.get("--description", [""])[0],
+                "type": args.get("--type", ["FunctionalUnit"])[0],
+                "status": args.get("--status", ["Draft"])[0],
+            }
+            # Support parent domain ID passed via CLI as --parent-domain-id
+            parent_id = args.get("--parent-domain-id", [""])[0]
+            if parent_id:
+                payload["parentId"] = parent_id
+
+        # If payload file contains parentId or parentDomainId, keep it as-is
+        self.payload = payload
 
     @decorator
     def update_governance_domain(self, args):
@@ -411,57 +421,102 @@ class UnifiedCatalogClient(Endpoint):
 
         self.payload = payload
 
-    @decorator
     def update_term(self, args):
-        """Update an existing Unified Catalog term."""
+        """Update an existing Unified Catalog term (supports partial updates)."""
+        from purviewcli.client.endpoint import get_data
+        
         term_id = args.get("--term-id", [""])[0]
-        self.method = "PUT"
-        self.endpoint = f"/datagovernance/catalog/terms/{term_id}"
-
-        # Build payload with all fields (UC API requires full object)
-        domain_id = args.get("--governance-domain-id", [""])[0]
-        name = args.get("--name", [""])[0]
-        description = args.get("--description", [""])[0]
-        status = args.get("--status", ["Draft"])[0]
         
-        # Get owner IDs if provided
-        owner_ids = args.get("--owner-id", [])
-        owners = []
-        if owner_ids:
-            for owner_id in owner_ids:
-                owners.append({"id": owner_id})
+        # First, fetch the existing term to get current values
+        fetch_client = UnifiedCatalogClient()
+        existing_term = fetch_client.get_term_by_id({"--term-id": [term_id]})
         
-        # Get acronyms if provided
-        acronyms = args.get("--acronym", [])
+        if not existing_term or (isinstance(existing_term, dict) and existing_term.get("error")):
+            return {"error": f"Could not fetch existing term {term_id}"}
         
-        # Get resources if provided
-        resources = []
+        # Start with existing term data
+        payload = {
+            "id": term_id,
+            "name": existing_term.get("name", ""),
+            "description": existing_term.get("description", ""),
+            "domain": existing_term.get("domain", ""),
+            "status": existing_term.get("status", "Draft"),
+        }
+        
+        # Update with provided values (only if explicitly provided)
+        if args.get("--name"):
+            payload["name"] = args["--name"][0]
+        if "--description" in args:  # Allow empty string
+            payload["description"] = args.get("--description", [""])[0]
+        if args.get("--governance-domain-id"):
+            payload["domain"] = args["--governance-domain-id"][0]
+        if args.get("--status"):
+            payload["status"] = args["--status"][0]
+        
+        # Handle owners - replace or add to existing
+        contacts = existing_term.get("contacts") or {}
+        existing_owners = contacts.get("owner", []) if isinstance(contacts, dict) else []
+        if args.get("--owner-id"):
+            # Replace owners
+            owners = [{"id": oid} for oid in args["--owner-id"]]
+            payload["contacts"] = {"owner": owners}
+        elif args.get("--add-owner-id"):
+            # Add to existing owners
+            existing_owner_ids = set()
+            if isinstance(existing_owners, list):
+                for o in existing_owners:
+                    if isinstance(o, dict) and o.get("id"):
+                        existing_owner_ids.add(o.get("id"))
+            new_owner_ids = args["--add-owner-id"]
+            combined_owner_ids = existing_owner_ids.union(set(new_owner_ids))
+            owners = [{"id": oid} for oid in combined_owner_ids]
+            payload["contacts"] = {"owner": owners}
+        elif existing_owners:
+            # Keep existing owners
+            payload["contacts"] = {"owner": existing_owners}
+        
+        # Handle acronyms - replace or add to existing
+        existing_acronyms = existing_term.get("acronyms", []) or []
+        if args.get("--acronym"):
+            # Replace acronyms
+            payload["acronyms"] = list(args["--acronym"])
+        elif args.get("--add-acronym"):
+            # Add to existing acronyms
+            combined_acronyms = list(set(existing_acronyms + list(args["--add-acronym"])))
+            payload["acronyms"] = combined_acronyms
+        elif existing_acronyms:
+            # Keep existing acronyms
+            payload["acronyms"] = existing_acronyms
+        
+        # Handle resources - replace with new ones if provided
+        existing_resources = existing_term.get("resources", []) or []
         resource_names = args.get("--resource-name", [])
         resource_urls = args.get("--resource-url", [])
         if resource_names and resource_urls:
+            # Replace resources
+            resources = []
             for i in range(min(len(resource_names), len(resource_urls))):
                 resources.append({
                     "name": resource_names[i],
                     "url": resource_urls[i]
                 })
-        
-        payload = {
-            "id": term_id,
-            "name": name,
-            "description": description,
-            "domain": domain_id,
-            "status": status,
+            payload["resources"] = resources
+        elif existing_resources:
+            # Keep existing resources
+            payload["resources"] = existing_resources
+
+        # Now make the actual PUT request
+        http_dict = {
+            "app": "datagovernance",
+            "method": "PUT",
+            "endpoint": f"/datagovernance/catalog/terms/{term_id}",
+            "params": {},
+            "payload": payload,
+            "files": None,
+            "headers": {},
         }
         
-        # Add optional fields
-        if owners:
-            payload["contacts"] = {"owner": owners}
-        if acronyms:
-            payload["acronyms"] = acronyms
-        if resources:
-            payload["resources"] = resources
-
-        self.payload = payload
+        return get_data(http_dict)
 
     @decorator
     def delete_term(self, args):

purviewcli/client/api_client.py

@@ -5,7 +5,10 @@ Supports the latest Microsoft Purview REST API specifications with comprehensive
 
 import json
 import asyncio
-import aiohttp
+try:
+    import aiohttp
+except Exception:
+    aiohttp = None
 import pandas as pd
 from typing import Dict, List, Optional, Union, Any
 from dataclasses import dataclass
@@ -73,6 +76,11 @@ class PurviewClient:
 
     async def _initialize_session(self):
         """Initialize HTTP session and authentication"""
+        if aiohttp is None:
+            raise RuntimeError(
+                "The 'aiohttp' package is required for Purview async operations. "
+                "Install it in your environment (e.g. '.venv\\Scripts\\pip.exe install aiohttp' or 'pip install aiohttp')."
+            )
         self._credential = DefaultAzureCredential()
 
         try:

{pvw_cli-1.0.11.dist-info → pvw_cli-1.0.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pvw-cli
-Version: 1.0.11
+Version: 1.0.12
 Summary: Microsoft Purview CLI with comprehensive automation capabilities
 Author-email: AYOUB KEBAILI <keayoub@msn.com>
 Maintainer-email: AYOUB KEBAILI <keayoub@msn.com>
@@ -56,7 +56,7 @@ Requires-Dist: pytest-asyncio>=0.20.0; extra == "test"
 Requires-Dist: pytest-cov>=4.0.0; extra == "test"
 Requires-Dist: requests-mock>=1.9.0; extra == "test"
 
-# PURVIEW CLI v1.0.11 - Microsoft Purview Automation & Data Governance
+# PURVIEW CLI v1.0.12 - Microsoft Purview Automation & Data Governance
 
 > **LATEST UPDATE (October 2025):**
 > - **🚀 NEW: Complete Data Product CRUD Operations** - Full update and delete support with smart partial updates
@@ -73,7 +73,7 @@ Requires-Dist: requests-mock>=1.9.0; extra == "test"
 
 ## What is PVW CLI?
 
-**PVW CLI v1.0.11** is a modern, full-featured command-line interface and Python library for Microsoft Purview. It enables automation and management of *all major Purview APIs* including:
+**PVW CLI v1.0.12** is a modern, full-featured command-line interface and Python library for Microsoft Purview. It enables automation and management of *all major Purview APIs* including:
 
 - **NEW Unified Catalog (UC) Management** - Complete governance domains, glossary terms, data products, OKRs, CDEs (NEW)
 - Entity management (create, update, bulk, import/export)
@@ -141,7 +141,7 @@ For more advanced usage, see the sections below or visit the [documentation](htt
 
 ## Overview
 
-**PVW CLI v1.0.11** is a modern command-line interface and Python library for Microsoft Purview, enabling:
+**PVW CLI v1.0.12** is a modern command-line interface and Python library for Microsoft Purview, enabling:
 
 - Advanced data catalog search and discovery
 - Bulk import/export of entities, glossary terms, and lineage

{pvw_cli-1.0.11.dist-info → pvw_cli-1.0.12.dist-info}/RECORD

@@ -1,4 +1,4 @@
-purviewcli/__init__.py,sha256=dZabjy1DRPdTFgczuBorfIVXE9tYm-8Z5MQK1meA86I,414
+purviewcli/__init__.py,sha256=vZJuLbYKqxhX_kkKROUbb5uUzClrtVWClRZ7pv7eyKw,414
 purviewcli/__main__.py,sha256=n_PFo1PjW8L1OKCNLsW0vlVSo8tzac_saEYYLTu93iQ,372
 purviewcli/cli/__init__.py,sha256=UGMctZaXXsV2l2ycnmhTgyksH81_JBQjAPq3oRF2Dqk,56
 purviewcli/cli/account.py,sha256=YENHkBD0VREajDqtlkTJ-zUvq8aq7LF52HDSOSsgku8,7080
@@ -17,7 +17,7 @@ purviewcli/cli/scan.py,sha256=91iKDH8iVNJKndJAisrKx3J4HRoPH2qfmxguLZH3xHY,13807
 purviewcli/cli/search.py,sha256=B0Ae3-9JCTKICOkJrYS29tMiFTuLJzlx0ISW_23OHF0,13599
 purviewcli/cli/share.py,sha256=QRZhHM59RxdYqXOjSYLfVRZmjwMg4Y-bWxMSQVTQiIE,20197
 purviewcli/cli/types.py,sha256=zo_8rAqDQ1vqi5y-dBh_sVY6i16UaJLLx_vBJBfZrrw,23729
-purviewcli/cli/unified_catalog.py,sha256=N22rgUA2V36lxX1iWxqY7o5zYz5arYza9jALWn1ce-8,44668
+purviewcli/cli/unified_catalog.py,sha256=KhpLpppNpv_TIqcUQwO8Mf4GMsseK5PfUYxStNpufVA,49049
 purviewcli/cli/workflow.py,sha256=wZj5p9fwiPiftKQwGqnn3asAqKuLhYvXRNDcpJQr8WY,14714
 purviewcli/client/__init__.py,sha256=qjhTkXkgxlNUY3R1HkrT_Znt03-2d8JDolPVOeVv2xI,37
 purviewcli/client/_account.py,sha256=5lacA7vvjGBLHUDRjFR7B5E8eN6T07rctVDRXR9JFTY,12397
@@ -35,9 +35,9 @@ purviewcli/client/_scan.py,sha256=2atEBD-kKWtFuBSWh2P0cwp42gfg7qgwWq-072QZMs4,15
 purviewcli/client/_search.py,sha256=vUDgjZtnNkHaCqsCXPp1Drq9Kknrkid17RNSXZhi1yw,11890
 purviewcli/client/_share.py,sha256=vKENIhePuzi3WQazNfv5U9y-6yxRk222zrFA-SGh1pc,10494
 purviewcli/client/_types.py,sha256=ONa3wh1F02QOVy51UGq54121TkqRcWczdXIvNqPIFU0,15454
-purviewcli/client/_unified_catalog.py,sha256=RlpcoCFOiD1dwMKMuY0Gm0qhn9ystyyJDc3Mo1hF-nc,36819
+purviewcli/client/_unified_catalog.py,sha256=S2t7hIA_wmaZPRVHkIgBkixqKpO1YRduGfIwoz0hkcg,39760
 purviewcli/client/_workflow.py,sha256=po5lomq07s3d7IAzZ5ved5JO6SsBU_JUA4lQSObdJR4,17904
-purviewcli/client/api_client.py,sha256=ZLpNdItu8H2Rfj0HCud2A67Gml7YCS5ZuhR5lrR0r5g,22637
+purviewcli/client/api_client.py,sha256=rNRUhkmZhoCHKWhUvZFUXEWj5eC8LSSnXYYNMb5lHNM,22964
 purviewcli/client/business_rules.py,sha256=VR4QqOE1Pg0nFjqAE-zbt-KqIenvzImLU-TBLki9bYc,27560
 purviewcli/client/config.py,sha256=pQIA168XxeddTSaZJ5qXI7KolIrLqDyBTgbILdDzEs0,7963
 purviewcli/client/data_quality.py,sha256=lAb-ma5MY2nyY4Dq8Q5wN9wzY0J9FikiQN8jPO2u6VU,14988
@@ -53,8 +53,8 @@ purviewcli/client/settings.py,sha256=nYdnYurTZsgv9vcgljnzVxLPtYVl9q6IplqOzi1aRvI
 purviewcli/client/sync_client.py,sha256=gwCqesJTNaXn1Q-j57O95R9mn3fIOhdP4sc8jBaBcYw,9493
 purviewcli/plugins/__init__.py,sha256=rpt3OhFt_wSE_o8Ga8AXvw1pqkdBxLmjrhYtE_-LuJo,29
 purviewcli/plugins/plugin_system.py,sha256=C-_dL4FUj90o1JS7Saxkpov6fz0GIF5PFhZTYwqBkWE,26774
-pvw_cli-1.0.11.dist-info/METADATA,sha256=704lbXcsxaSK_H62_8SHSmhQqKrTtSA5tclHP7KwVlc,28082
-pvw_cli-1.0.11.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pvw_cli-1.0.11.dist-info/entry_points.txt,sha256=VI6AAbc6sWahOCX7sn_lhJIr9OiJM0pHF7rmw1YVGlE,82
-pvw_cli-1.0.11.dist-info/top_level.txt,sha256=LrADzPoKwF1xY0pGKpWauyOVruHCIWKCkT7cwIl6IuI,11
-pvw_cli-1.0.11.dist-info/RECORD,,
+pvw_cli-1.0.12.dist-info/METADATA,sha256=r4MVe5jOF7nNC7bLNnqhTIVDF5nQ8mkbJlVK9OAXO5E,28082
+pvw_cli-1.0.12.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pvw_cli-1.0.12.dist-info/entry_points.txt,sha256=VI6AAbc6sWahOCX7sn_lhJIr9OiJM0pHF7rmw1YVGlE,82
+pvw_cli-1.0.12.dist-info/top_level.txt,sha256=LrADzPoKwF1xY0pGKpWauyOVruHCIWKCkT7cwIl6IuI,11
+pvw_cli-1.0.12.dist-info/RECORD,,