pvw-cli 1.2.8__py3-none-any.whl

purviewcli/__init__.py

@@ -0,0 +1,27 @@
+__version__ = "1.2.8"
+
+# Import main client modules
+from .client import *
+from .cli import *
+
+__all__ = [
+    "__version__",
+    # Client modules
+    "PurviewClient",
+    # CLI modules  
+    "cli",
+    "account",
+    "entity", 
+    "glossary",
+    "lineage",
+    "search",
+    "scan",
+    "types",
+    "relationship",
+    "management",
+    "policystore",
+    "insight",
+    "share",
+    "collections",
+    "uc",
+]

purviewcli/__main__.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python3
+"""
+Main entry point for the purviewcli package.
+Allows the CLI to be executed with: python -m purviewcli
+"""
+
+from purviewcli.cli.cli import main
+
+if __name__ == '__main__':
+    import sys
+    if '--version' in sys.argv:
+        from purviewcli import __version__
+        print(f"Purview CLI version: {__version__}")
+        sys.exit(0)
+    main()

purviewcli/cli/__init__.py

@@ -0,0 +1,5 @@
+from .unified_catalog import uc
+
+__all__ = [
+    "uc",
+]

purviewcli/cli/account.py

@@ -0,0 +1,199 @@
+"""
+Manage Purview account and collections using modular Click-based commands.
+
+Usage:
+  account get-account           Get account information
+  account get-access-keys       Get account access keys
+  account regenerate-access-keys Regenerate account access keys
+  account update-account        Update account information
+  account get-collections       Get all collections
+  account get-collection        Get specific collection information
+  account --help                Show this help message and exit
+
+Options:
+  -h --help                     Show this help message and exit
+  
+"""
+
+import json
+import click
+from rich.console import Console
+
+console = Console()
+
+
+@click.group()
+@click.pass_context
+def account(ctx):
+    """
+    Manage Purview account and collections.
+    """
+    pass
+
+
+@account.command()
+@click.pass_context
+def get_account(ctx):
+    """Get account information"""
+    try:
+        if ctx.obj.get("mock"):
+            console.print("[yellow]🎭 Mock: account get-account command[/yellow]")
+            console.print("[green][OK] Mock account get-account completed successfully[/green]")
+            return
+
+        args = {}
+
+        from purviewcli.client._account import Account
+        account_client = Account()
+        result = account_client.accountRead(args)
+
+        if result:
+            console.print("[green][OK] Account information retrieved successfully[/green]")
+            console.print(json.dumps(result, indent=2))
+        else:
+            console.print("[yellow][!] Account get-account completed with no result[/yellow]")
+
+    except Exception as e:
+        console.print(f"[red][X] Error executing account get-account: {str(e)}[/red]")
+
+
+@account.command()
+@click.pass_context
+def get_access_keys(ctx):
+    """Get account access keys"""
+    try:
+        if ctx.obj.get("mock"):
+            console.print("[yellow]🎭 Mock: account get-access-keys command[/yellow]")
+            console.print("[green][OK] Mock account get-access-keys completed successfully[/green]")
+            return
+
+        args = {}
+
+        from purviewcli.client._account import Account
+        account_client = Account()
+        result = account_client.accountReadAccessKeys(args)
+
+        if result:
+            console.print("[green][OK] Access keys retrieved successfully[/green]")
+            console.print(json.dumps(result, indent=2))
+        else:
+            console.print("[yellow][!] Account get-access-keys completed with no result[/yellow]")
+
+    except Exception as e:
+        console.print(f"[red][X] Error executing account get-access-keys: {str(e)}[/red]")
+
+
+@account.command()
+@click.option('--key-type', required=True, 
+              type=click.Choice(['AtlasKafkaPrimaryKey', 'AtlasKafkaSecondaryKey']),
+              help='The access key type to regenerate')
+@click.pass_context
+def regenerate_access_keys(ctx, key_type):
+    """Regenerate account access keys"""
+    try:
+        if ctx.obj.get("mock"):
+            console.print("[yellow]🎭 Mock: account regenerate-access-keys command[/yellow]")
+            console.print(f"[dim]Key Type: {key_type}[/dim]")
+            console.print("[green][OK] Mock account regenerate-access-keys completed successfully[/green]")
+            return
+
+        args = {"--keyType": key_type}
+
+        from purviewcli.client._account import Account
+        account_client = Account()
+        result = account_client.accountRegenerateAccessKey(args)
+
+        if result:
+            console.print("[green][OK] Access keys regenerated successfully[/green]")
+            console.print(json.dumps(result, indent=2))
+        else:
+            console.print("[yellow][!] Account regenerate-access-keys completed with no result[/yellow]")
+
+    except Exception as e:
+        console.print(f"[red][X] Error executing account regenerate-access-keys: {str(e)}[/red]")
+
+
+@account.command()
+@click.option('--friendly-name', required=True, help='The friendly name for the azure resource')
+@click.pass_context
+def update_account(ctx, friendly_name):
+    """Update account information"""
+    try:
+        if ctx.obj.get("mock"):
+            console.print("[yellow]🎭 Mock: account update-account command[/yellow]")
+            console.print(f"[dim]Friendly Name: {friendly_name}[/dim]")
+            console.print("[green][OK] Mock account update-account completed successfully[/green]")
+            return
+
+        args = {"--friendlyName": friendly_name}
+
+        from purviewcli.client._account import Account
+        account_client = Account()
+        result = account_client.accountUpdate(args)
+
+        if result:
+            console.print("[green][OK] Account updated successfully[/green]")
+            console.print(json.dumps(result, indent=2))
+        else:
+            console.print("[yellow][!] Account update-account completed with no result[/yellow]")
+
+    except Exception as e:
+        console.print(f"[red][X] Error executing account update-account: {str(e)}[/red]")
+
+
+@account.command()
+@click.pass_context
+def get_collections(ctx):
+    """Get all collections"""
+    try:
+        if ctx.obj.get("mock"):
+            console.print("[yellow]🎭 Mock: account get-collections command[/yellow]")
+            console.print("[green][OK] Mock account get-collections completed successfully[/green]")
+            return
+
+        args = {}
+
+        from purviewcli.client._collections import Collections
+        account_client = Collections()
+        result = account_client.collectionsRead(args)
+
+        if result:
+            console.print("[green][OK] Collections retrieved successfully[/green]")
+            console.print(json.dumps(result, indent=2))
+        else:
+            console.print("[yellow][!] Account get-collections completed with no result[/yellow]")
+
+    except Exception as e:
+        console.print(f"[red][X] Error executing account get-collections: {str(e)}[/red]")
+
+
+@account.command()
+@click.option('--collection-name', required=True, help='The technical name of the collection')
+@click.pass_context
+def get_collection(ctx, collection_name):
+    """Get specific collection information"""
+    try:
+        if ctx.obj.get("mock"):
+            console.print("[yellow]🎭 Mock: account get-collection command[/yellow]")
+            console.print(f"[dim]Collection Name: {collection_name}[/dim]")
+            console.print("[green][OK] Mock account get-collection completed successfully[/green]")
+            return
+
+        args = {"--collectionName": collection_name}
+
+        from purviewcli.client._collections import Collections
+        account_client = Collections()
+        result = account_client.collectionsRead(args)
+
+        if result:
+            console.print("[green][OK] Collection information retrieved successfully[/green]")
+            console.print(json.dumps(result, indent=2))
+        else:
+            console.print("[yellow][!] Account get-collection completed with no result[/yellow]")
+
+    except Exception as e:
+        console.print(f"[red][X] Error executing account get-collection: {str(e)}[/red]")
+
+
+# Make the account group available for import
+__all__ = ['account']

purviewcli/cli/cli.py

@@ -0,0 +1,170 @@
+"""
+Purview CLI (pvw) - Production Version
+======================================
+
+A comprehensive, automation-friendly command-line interface for Microsoft Purview.
+"""
+
+import json
+import sys
+import re
+import traceback
+from datetime import datetime
+from pathlib import Path
+from typing import Dict, List, Optional
+
+import click
+from rich.console import Console
+
+console = Console()
+
+# Import version for the CLI
+try:
+    from purviewcli import __version__
+except ImportError:
+    __version__ = "unknown"
+
+
+# ============================================================================
+# INDIVIDUAL CLI MODULE REGISTRATION SYSTEM
+# ============================================================================
+def register_individual_cli_modules(main_group):
+    """
+    Register all CLI command groups as modular Click-based modules for full visibility and maintainability.
+    Each group is implemented in its own file in purviewcli/cli/ and exposes all real subcommands.
+    """
+    try:
+        from .lineage import lineage
+
+        main_group.add_command(lineage)
+    except ImportError as e:
+        console.print(f"[yellow][!] Could not import lineage CLI module: {e}[/yellow]")
+    try:
+        from .account import account
+
+        main_group.add_command(account)
+    except ImportError as e:
+        console.print(f"[yellow][!] Could not import account CLI module: {e}[/yellow]")
+    try:
+        from .entity import entity
+
+        main_group.add_command(entity)
+    except ImportError as e:
+        console.print(f"[yellow][!] Could not import entity CLI module: {e}[/yellow]")
+    try:
+        from .insight import insight
+
+        main_group.add_command(insight)
+    except ImportError as e:
+        console.print(f"[yellow][!] Could not import insight CLI module: {e}[/yellow]")
+    try:
+        from .glossary import glossary
+
+        main_group.add_command(glossary)
+    except ImportError as e:
+        console.print(f"[yellow][!] Could not import glossary CLI module: {e}[/yellow]")
+    try:
+        from .management import management
+
+        main_group.add_command(management)
+    except ImportError as e:
+        console.print(f"[yellow][!] Could not import management CLI module: {e}[/yellow]")
+    try:
+        from .policystore import policystore
+
+        main_group.add_command(policystore)
+    except ImportError as e:
+        console.print(f"[yellow][!] Could not import policystore CLI module: {e}[/yellow]")
+    try:
+        from .relationship import relationship
+
+        main_group.add_command(relationship)
+    except ImportError as e:
+        console.print(f"[yellow][!] Could not import relationship CLI module: {e}[/yellow]")
+    try:
+        from .scan import scan
+
+        main_group.add_command(scan)
+
+    except ImportError as e:
+        console.print(f"[yellow][!] Could not import scan CLI module: {e}[/yellow]")
+    try:
+        from .search import search
+
+        main_group.add_command(search)
+    except ImportError as e:
+        console.print(f"[yellow][!] Could not import search CLI module: {e}[/yellow]")
+    try:
+        from .share import share
+
+        main_group.add_command(share)
+    except ImportError as e:
+        console.print(f"[yellow][!] Could not import share CLI module: {e}[/yellow]")
+    try:
+        from .types import types
+        main_group.add_command(types)
+    except ImportError as e:
+        console.print(f"[yellow][!] Could not import types CLI module: {e}[/yellow]")
+    try:
+        from .collections import collections
+        main_group.add_command(collections, name="collections")
+        # Removed domain alias to avoid conflicts with dedicated domain module
+    except ImportError as e:
+        console.print(f"[yellow][!] Could not import collections CLI module: {e}[/yellow]")
+    try:
+        from .unified_catalog import uc
+
+        main_group.add_command(uc)  # Main Unified Catalog command
+    except ImportError as e:
+        console.print(f"[yellow][!] Could not import unified catalog (uc) CLI module: {e}[/yellow]")
+    try:
+        from .domain import domain
+
+        main_group.add_command(domain)
+    except ImportError as e:
+        console.print(f"[yellow][!] Could not import domain CLI module: {e}[/yellow]")
+    try:
+        from .workflow import workflow
+
+        main_group.add_command(workflow)
+    except ImportError as e:
+        console.print(f"[yellow][!] Could not import workflow CLI module: {e}[/yellow]")
+
+
+@click.group()
+@click.version_option(version=__version__, prog_name="pvw")
+@click.option("--profile", help="Configuration profile to use")
+@click.option("--account-name", help="Override Purview account name")
+@click.option(
+    "--endpoint", help="Purview account endpoint (e.g. https://<your-account>.purview.azure.com)"
+)
+@click.option("--token", help="Azure AD access token for authentication")
+@click.option("--debug", is_flag=True, help="Enable debug mode")
+@click.option("--mock", is_flag=True, help="Mock mode - simulate commands without real API calls")
+@click.pass_context
+def main(ctx, profile, account_name, endpoint, token, debug, mock):
+    """
+    Purview CLI with profile management and automation.
+    All command groups are registered as modular Click-based modules for full CLI visibility.
+    """
+    ctx.ensure_object(dict)
+
+    if debug:
+        console.print("[cyan]Debug mode enabled[/cyan]")
+    if mock:
+        console.print("[yellow]Mock mode enabled - commands will be simulated[/yellow]")
+
+    # Store basic config
+    ctx.obj["account_name"] = account_name
+    ctx.obj["profile"] = profile
+    ctx.obj["debug"] = debug
+    ctx.obj["mock"] = mock
+    ctx.obj["endpoint"] = endpoint
+    ctx.obj["token"] = token
+
+
+# Register all Click-based CLI modules after main is defined
+register_individual_cli_modules(main)
+
+if __name__ == "__main__":
+    main()