pvw-cli 1.2.8__py3-none-any.whl

purviewcli/cli/workflow.py

@@ -0,0 +1,402 @@
+"""
+Microsoft Purview Workflow CLI Commands
+Provides command-line interface for workflow management operations
+"""
+
+import click
+import json
+from rich.console import Console
+
+console = Console()
+
+
+@click.group()
+def workflow():
+    """Manage workflows and approval processes in Microsoft Purview."""
+    pass
+
+
+# ========== Basic Workflow Management Commands ==========
+
+
+@workflow.command()
+@click.option("--json", "output_json", is_flag=True, help="Output results in JSON format")
+@click.pass_context
+def list(ctx, output_json):
+    """List all workflows."""
+    try:
+        if ctx.obj and ctx.obj.get("mock"):
+            console.print("[yellow]🎭 Mock: workflow list command[/yellow]")
+            console.print("[green][OK] Mock workflow list completed successfully[/green]")
+            return
+
+        from purviewcli.client._workflow import Workflow
+        from rich.table import Table
+
+        args = {}
+        workflow_client = Workflow()
+        result = workflow_client.workflowListWorkflows(args)
+
+        # Handle response structure
+        if isinstance(result, dict):
+            workflows = result.get("results", []) or result.get("value", [])
+        elif isinstance(result, (list, tuple)):
+            workflows = result
+        else:
+            workflows = []
+
+        if not workflows:
+            console.print("[yellow][!] No workflows found[/yellow]")
+            return
+
+        # Output in JSON format if requested
+        if output_json:
+            console.print(json.dumps(workflows, indent=2))
+            return
+
+        table = Table(title="Workflows", show_lines=True)
+        table.add_column("ID", style="cyan", no_wrap=True, width=38)
+        table.add_column("Name", style="green", width=30)
+        table.add_column("Type", style="blue")
+        table.add_column("Status", style="yellow")
+        table.add_column("Description", style="white")
+
+        for wf in workflows:
+            if not isinstance(wf, dict):
+                continue
+            
+            workflow_id = wf.get("id", "N/A")
+            name = wf.get("name", "N/A")
+            wf_type = wf.get("type", "N/A")
+            status = wf.get("status", "N/A")
+            description = wf.get("description", "")
+            
+            # Truncate description if too long
+            if len(description) > 60:
+                description = description[:60] + "..."
+            
+            table.add_row(workflow_id, name, wf_type, status, description)
+
+        console.print(table)
+        console.print(f"\n[dim]Total: {len(workflows)} workflow(s)[/dim]")
+
+    except Exception as e:
+        console.print(f"[red][X] Error executing workflow list: {str(e)}[/red]")
+
+
+@workflow.command()
+@click.option("--workflow-id", required=True, help="Workflow ID")
+@click.option(
+    "--payload-file",
+    required=True,
+    type=click.Path(exists=True),
+    help="JSON file with workflow definition",
+)
+@click.pass_context
+def create(ctx, workflow_id, payload_file):
+    """Create a new workflow."""
+    try:
+        if ctx.obj and ctx.obj.get("mock"):
+            console.print("[yellow]🎭 Mock: workflow create command[/yellow]")
+            console.print(f"[dim]Workflow ID: {workflow_id}[/dim]")
+            console.print(f"[dim]Payload File: {payload_file}[/dim]")
+            console.print("[green][OK] Mock workflow create completed successfully[/green]")
+            return
+
+        from purviewcli.client._workflow import Workflow
+
+        args = {"--workflowId": workflow_id, "--payloadFile": payload_file}
+        workflow_client = Workflow()
+        result = workflow_client.workflowCreateWorkflow(args)
+
+        if result:
+            console.print("[green][OK] Workflow create completed successfully[/green]")
+            console.print(json.dumps(result, indent=2))
+        else:
+            console.print("[yellow][!] Workflow create completed with no result[/yellow]")
+    except Exception as e:
+        console.print(f"[red][X] Error executing workflow create: {str(e)}[/red]")
+
+
+@workflow.command()
+@click.option("--workflow-id", required=True, help="Workflow ID")
+@click.pass_context
+def get(ctx, workflow_id):
+    """Get a specific workflow."""
+    try:
+        if ctx.obj and ctx.obj.get("mock"):
+            console.print("[yellow]🎭 Mock: workflow get command[/yellow]")
+            console.print(f"[dim]Workflow ID: {workflow_id}[/dim]")
+            console.print("[green][OK] Mock workflow get completed successfully[/green]")
+            return
+
+        from purviewcli.client._workflow import Workflow
+
+        args = {"--workflowId": workflow_id}
+        workflow_client = Workflow()
+        result = workflow_client.workflowGetWorkflow(args)
+
+        if result:
+            console.print("[green][OK] Workflow get completed successfully[/green]")
+            console.print(json.dumps(result, indent=2))
+        else:
+            console.print("[yellow][!] Workflow not found[/yellow]")
+    except Exception as e:
+        console.print(f"[red][X] Error executing workflow get: {str(e)}[/red]")
+
+
+@workflow.command()
+@click.option("--workflow-id", required=True, help="Workflow ID")
+@click.option(
+    "--payload-file", type=click.Path(exists=True), help="JSON file with execution parameters"
+)
+@click.pass_context
+def execute(ctx, workflow_id, payload_file):
+    """Execute a workflow."""
+    try:
+        if ctx.obj and ctx.obj.get("mock"):
+            console.print("[yellow]🎭 Mock: workflow execute command[/yellow]")
+            console.print(f"[dim]Workflow ID: {workflow_id}[/dim]")
+            if payload_file:
+                console.print(f"[dim]Payload File: {payload_file}[/dim]")
+            console.print("[green][OK] Mock workflow execute completed successfully[/green]")
+            return
+
+        from purviewcli.client._workflow import Workflow
+
+        args = {"--workflowId": workflow_id}
+        if payload_file:
+            args["--payloadFile"] = payload_file
+        workflow_client = Workflow()
+        result = workflow_client.workflowExecuteWorkflow(args)
+
+        if result:
+            console.print("[green][OK] Workflow execute completed successfully[/green]")
+            console.print(json.dumps(result, indent=2))
+        else:
+            console.print("[yellow][!] Workflow execute completed with no result[/yellow]")
+    except Exception as e:
+        console.print(f"[red][X] Error executing workflow: {str(e)}[/red]")
+
+
+@workflow.command()
+@click.option("--workflow-id", required=True, help="Workflow ID")
+@click.pass_context
+def executions(ctx, workflow_id):
+    """List workflow executions."""
+    try:
+        if ctx.obj and ctx.obj.get("mock"):
+            console.print("[yellow]🎭 Mock: workflow executions command[/yellow]")
+            console.print(f"[dim]Workflow ID: {workflow_id}[/dim]")
+            console.print("[green][OK] Mock workflow executions completed successfully[/green]")
+            return
+
+        from purviewcli.client._workflow import Workflow
+
+        args = {"--workflowId": workflow_id}
+        workflow_client = Workflow()
+        result = workflow_client.workflowListWorkflowExecutions(args)
+
+        if result:
+            console.print("[green][OK] Workflow executions list completed successfully[/green]")
+            console.print(json.dumps(result, indent=2))
+        else:
+            console.print("[yellow][!] No workflow executions found[/yellow]")
+    except Exception as e:
+        console.print(f"[red][X] Error listing workflow executions: {str(e)}[/red]")
+
+
+# ========== Approval Commands ==========
+
+
+@workflow.command()
+@click.option("--status", help="Filter by approval status")
+@click.option("--assigned-to", help="Filter by assignee")
+@click.pass_context
+def approvals(ctx, status, assigned_to):
+    """List approval requests."""
+    try:
+        if ctx.obj and ctx.obj.get("mock"):
+            console.print("[yellow]🎭 Mock: workflow approvals command[/yellow]")
+            if status:
+                console.print(f"[dim]Status Filter: {status}[/dim]")
+            if assigned_to:
+                console.print(f"[dim]Assigned To: {assigned_to}[/dim]")
+            console.print("[green][OK] Mock workflow approvals completed successfully[/green]")
+            return
+
+        from purviewcli.client._workflow import Workflow
+
+        args = {}
+        if status:
+            args["--status"] = status
+        if assigned_to:
+            args["--assignedTo"] = assigned_to
+        workflow_client = Workflow()
+        result = workflow_client.workflowGetApprovalRequests(args)
+
+        if result:
+            console.print("[green][OK] Approval requests list completed successfully[/green]")
+            console.print(json.dumps(result, indent=2))
+        else:
+            console.print("[yellow][!] No approval requests found[/yellow]")
+    except Exception as e:
+        console.print(f"[red][X] Error listing approval requests: {str(e)}[/red]")
+
+
+@workflow.command()
+@click.option("--request-id", required=True, help="Approval request ID")
+@click.option("--comments", help="Approval comments")
+@click.pass_context
+def approve(ctx, request_id, comments):
+    """Approve a request."""
+    try:
+        if ctx.obj and ctx.obj.get("mock"):
+            console.print("[yellow]🎭 Mock: workflow approve command[/yellow]")
+            console.print(f"[dim]Request ID: {request_id}[/dim]")
+            if comments:
+                console.print(f"[dim]Comments: {comments}[/dim]")
+            console.print("[green][OK] Mock workflow approve completed successfully[/green]")
+            return
+
+        from purviewcli.client._workflow import Workflow
+
+        args = {"--requestId": request_id}
+        if comments:
+            args["--comments"] = comments
+        workflow_client = Workflow()
+        result = workflow_client.workflowApproveRequest(args)
+
+        if result:
+            console.print("[green][OK] Request approved successfully[/green]")
+            console.print(json.dumps(result, indent=2))
+        else:
+            console.print("[yellow][!] Request approval completed with no result[/yellow]")
+    except Exception as e:
+        console.print(f"[red][X] Error approving request: {str(e)}[/red]")
+
+
+@workflow.command()
+@click.option("--request-id", required=True, help="Approval request ID")
+@click.option("--comments", help="Rejection comments")
+@click.pass_context
+def reject(ctx, request_id, comments):
+    """Reject a request."""
+    try:
+        if ctx.obj and ctx.obj.get("mock"):
+            console.print("[yellow]🎭 Mock: workflow reject command[/yellow]")
+            console.print(f"[dim]Request ID: {request_id}[/dim]")
+            if comments:
+                console.print(f"[dim]Comments: {comments}[/dim]")
+            console.print("[green][OK] Mock workflow reject completed successfully[/green]")
+            return
+
+        from purviewcli.client._workflow import Workflow
+
+        args = {"--requestId": request_id}
+        if comments:
+            args["--comments"] = comments
+        workflow_client = Workflow()
+        result = workflow_client.workflowRejectRequest(args)
+
+        if result:
+            console.print("[green][OK] Request rejected successfully[/green]")
+            console.print(json.dumps(result, indent=2))
+        else:
+            console.print("[yellow][!] Request rejection completed with no result[/yellow]")
+    except Exception as e:
+        console.print(f"[red][X] Error rejecting request: {str(e)}[/red]")
+
+
+# ========== Template Commands ==========
+
+
+@workflow.command()
+@click.pass_context
+def templates(ctx):
+    """List available workflow templates."""
+    try:
+        if ctx.obj and ctx.obj.get("mock"):
+            console.print("[yellow]🎭 Mock: workflow templates command[/yellow]")
+            console.print("[green][OK] Mock workflow templates completed successfully[/green]")
+            return
+
+        from purviewcli.client._workflow import Workflow
+
+        args = {}
+        workflow_client = Workflow()
+        result = workflow_client.workflowListWorkflowTemplates(args)
+
+        if result:
+            console.print("[green][OK] Workflow templates list completed successfully[/green]")
+            console.print(json.dumps(result, indent=2))
+        else:
+            console.print("[yellow][!] No workflow templates found[/yellow]")
+    except Exception as e:
+        console.print(f"[red][X] Error listing workflow templates: {str(e)}[/red]")
+
+
+@workflow.command()
+@click.option("--template-id", required=True, help="Template ID")
+@click.pass_context
+def template(ctx, template_id):
+    """Get a specific workflow template."""
+    try:
+        if ctx.obj and ctx.obj.get("mock"):
+            console.print("[yellow]🎭 Mock: workflow template command[/yellow]")
+            console.print(f"[dim]Template ID: {template_id}[/dim]")
+            console.print("[green][OK] Mock workflow template completed successfully[/green]")
+            return
+
+        from purviewcli.client._workflow import Workflow
+
+        args = {"--templateId": template_id}
+        workflow_client = Workflow()
+        result = workflow_client.workflowGetWorkflowTemplate(args)
+
+        if result:
+            console.print("[green][OK] Workflow template get completed successfully[/green]")
+            console.print(json.dumps(result, indent=2))
+        else:
+            console.print("[yellow][!] Workflow template not found[/yellow]")
+    except Exception as e:
+        console.print(f"[red][X] Error getting workflow template: {str(e)}[/red]")
+
+
+# ========== Validation Commands ==========
+
+
+@workflow.command()
+@click.option(
+    "--payload-file",
+    required=True,
+    type=click.Path(exists=True),
+    help="JSON file with workflow definition to validate",
+)
+@click.pass_context
+def validate(ctx, payload_file):
+    """Validate a workflow definition."""
+    try:
+        if ctx.obj and ctx.obj.get("mock"):
+            console.print("[yellow]🎭 Mock: workflow validate command[/yellow]")
+            console.print(f"[dim]Payload File: {payload_file}[/dim]")
+            console.print("[green][OK] Mock workflow validate completed successfully[/green]")
+            return
+
+        from purviewcli.client._workflow import Workflow
+
+        args = {"--payloadFile": payload_file}
+        workflow_client = Workflow()
+        result = workflow_client.workflowValidateWorkflow(args)
+
+        if result:
+            console.print("[green][OK] Workflow validation completed successfully[/green]")
+            console.print(json.dumps(result, indent=2))
+        else:
+            console.print("[yellow][!] Workflow validation completed with no result[/yellow]")
+    except Exception as e:
+        console.print(f"[red][X] Error validating workflow: {str(e)}[/red]")
+
+
+if __name__ == "__main__":
+    workflow()

purviewcli/client/__init__.py

@@ -0,0 +1,21 @@
+from .api_client import PurviewClient
+from ._entity import Entity
+from ._glossary import Glossary
+from ._unified_catalog import UnifiedCatalogClient
+from ._collections import Collections
+from ._lineage import Lineage
+from ._search import Search
+from ._types import Types
+from ._relationship import Relationship
+
+__all__ = [
+    "PurviewClient",
+    "Entity",
+    "Glossary",
+    "UnifiedCatalogClient",
+    "Collections",
+    "Lineage",
+    "Search",
+    "Types",
+    "Relationship",
+]