pltr-cli 0.4.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

pltr/commands/resource.py

@@ -0,0 +1,499 @@
+"""
+Resource management commands for Foundry filesystem.
+"""
+
+import typer
+from typing import Optional, List
+from rich.console import Console
+from rich.table import Table
+
+from ..services.resource import ResourceService
+from ..utils.formatting import OutputFormatter
+from ..utils.progress import SpinnerProgressTracker
+from ..auth.base import ProfileNotFoundError, MissingCredentialsError
+from ..utils.completion import (
+    complete_rid,
+    complete_profile,
+    complete_output_format,
+    cache_rid,
+)
+
+app = typer.Typer()
+console = Console()
+formatter = OutputFormatter(console)
+
+
+@app.command("get")
+def get_resource(
+    resource_rid: str = typer.Argument(
+        ..., help="Resource Identifier", autocompletion=complete_rid
+    ),
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Profile name", autocompletion=complete_profile
+    ),
+    format: str = typer.Option(
+        "table",
+        "--format",
+        "-f",
+        help="Output format (table, json, csv)",
+        autocompletion=complete_output_format,
+    ),
+    output: Optional[str] = typer.Option(
+        None, "--output", "-o", help="Output file path"
+    ),
+):
+    """Get detailed information about a specific resource."""
+    try:
+        # Cache the RID for future completions
+        cache_rid(resource_rid)
+
+        service = ResourceService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(
+            f"Fetching resource {resource_rid}..."
+        ):
+            resource = service.get_resource(resource_rid)
+
+        # Format output
+        if format == "json":
+            if output:
+                formatter.save_to_file(resource, output, "json")
+            else:
+                formatter.format_dict(resource)
+        elif format == "csv":
+            if output:
+                formatter.save_to_file([resource], output, "csv")
+            else:
+                formatter.format_list([resource])
+        else:
+            _format_resource_table(resource)
+
+        if output:
+            formatter.print_success(f"Resource information saved to {output}")
+
+    except (ProfileNotFoundError, MissingCredentialsError) as e:
+        formatter.print_error(f"Authentication error: {e}")
+        raise typer.Exit(1)
+    except Exception as e:
+        formatter.print_error(f"Failed to get resource: {e}")
+        raise typer.Exit(1)
+
+
+@app.command("list")
+def list_resources(
+    folder_rid: Optional[str] = typer.Option(
+        None,
+        "--folder-rid",
+        "-f",
+        help="Folder Resource Identifier to filter by",
+        autocompletion=complete_rid,
+    ),
+    resource_type: Optional[str] = typer.Option(
+        None, "--type", "-t", help="Resource type to filter by (e.g., dataset, folder)"
+    ),
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Profile name", autocompletion=complete_profile
+    ),
+    format: str = typer.Option(
+        "table",
+        "--format",
+        "-o",
+        help="Output format (table, json, csv)",
+        autocompletion=complete_output_format,
+    ),
+    output: Optional[str] = typer.Option(None, "--output", help="Output file path"),
+    page_size: Optional[int] = typer.Option(
+        None, "--page-size", help="Number of items per page"
+    ),
+):
+    """List resources, optionally filtered by folder and type."""
+    try:
+        service = ResourceService(profile=profile)
+
+        filter_parts = []
+        if folder_rid:
+            filter_parts.append(f"in folder {folder_rid}")
+        if resource_type:
+            filter_parts.append(f"of type {resource_type}")
+
+        filter_desc = f" ({', '.join(filter_parts)})" if filter_parts else ""
+
+        with SpinnerProgressTracker().track_spinner(
+            f"Listing resources{filter_desc}..."
+        ):
+            resources = service.list_resources(
+                folder_rid=folder_rid,
+                resource_type=resource_type,
+                page_size=page_size,
+            )
+
+        if not resources:
+            formatter.print_info("No resources found.")
+            return
+
+        # Format output
+        if format == "json":
+            if output:
+                formatter.save_to_file(resources, output, "json")
+            else:
+                formatter.format_list(resources)
+        elif format == "csv":
+            if output:
+                formatter.save_to_file(resources, output, "csv")
+            else:
+                formatter.format_list(resources)
+        else:
+            _format_resources_table(resources)
+
+        if output:
+            formatter.print_success(f"Resources list saved to {output}")
+
+    except (ProfileNotFoundError, MissingCredentialsError) as e:
+        formatter.print_error(f"Authentication error: {e}")
+        raise typer.Exit(1)
+    except Exception as e:
+        formatter.print_error(f"Failed to list resources: {e}")
+        raise typer.Exit(1)
+
+
+@app.command("search")
+def search_resources(
+    query: str = typer.Argument(..., help="Search query string"),
+    resource_type: Optional[str] = typer.Option(
+        None, "--type", "-t", help="Resource type to filter by (e.g., dataset, folder)"
+    ),
+    folder_rid: Optional[str] = typer.Option(
+        None,
+        "--folder-rid",
+        "-f",
+        help="Folder to search within",
+        autocompletion=complete_rid,
+    ),
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Profile name", autocompletion=complete_profile
+    ),
+    format: str = typer.Option(
+        "table",
+        "--format",
+        "-o",
+        help="Output format (table, json, csv)",
+        autocompletion=complete_output_format,
+    ),
+    output: Optional[str] = typer.Option(None, "--output", help="Output file path"),
+    page_size: Optional[int] = typer.Option(
+        None, "--page-size", help="Number of items per page"
+    ),
+):
+    """Search for resources by query string."""
+    try:
+        service = ResourceService(profile=profile)
+
+        filter_parts = []
+        if resource_type:
+            filter_parts.append(f"type={resource_type}")
+        if folder_rid:
+            filter_parts.append(f"folder={folder_rid}")
+
+        filter_desc = f" ({', '.join(filter_parts)})" if filter_parts else ""
+
+        with SpinnerProgressTracker().track_spinner(
+            f"Searching resources for '{query}'{filter_desc}..."
+        ):
+            resources = service.search_resources(
+                query=query,
+                resource_type=resource_type,
+                folder_rid=folder_rid,
+                page_size=page_size,
+            )
+
+        if not resources:
+            formatter.print_info(f"No resources found matching '{query}'.")
+            return
+
+        # Format output
+        if format == "json":
+            if output:
+                formatter.save_to_file(resources, output, "json")
+            else:
+                formatter.format_list(resources)
+        elif format == "csv":
+            if output:
+                formatter.save_to_file(resources, output, "csv")
+            else:
+                formatter.format_list(resources)
+        else:
+            _format_resources_table(resources)
+
+        if output:
+            formatter.print_success(f"Search results saved to {output}")
+
+    except (ProfileNotFoundError, MissingCredentialsError) as e:
+        formatter.print_error(f"Authentication error: {e}")
+        raise typer.Exit(1)
+    except Exception as e:
+        formatter.print_error(f"Failed to search resources: {e}")
+        raise typer.Exit(1)
+
+
+@app.command("batch-get")
+def get_resources_batch(
+    resource_rids: List[str] = typer.Argument(
+        ..., help="Resource Identifiers (space-separated)"
+    ),
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Profile name", autocompletion=complete_profile
+    ),
+    format: str = typer.Option(
+        "table",
+        "--format",
+        "-f",
+        help="Output format (table, json, csv)",
+        autocompletion=complete_output_format,
+    ),
+    output: Optional[str] = typer.Option(
+        None, "--output", "-o", help="Output file path"
+    ),
+):
+    """Get multiple resources in a single request (max 1000)."""
+    try:
+        service = ResourceService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(
+            f"Fetching {len(resource_rids)} resources..."
+        ):
+            resources = service.get_resources_batch(resource_rids)
+
+        # Cache RIDs for future completions
+        for resource in resources:
+            if resource.get("rid"):
+                cache_rid(resource["rid"])
+
+        # Format output
+        if format == "json":
+            if output:
+                formatter.save_to_file(resources, output, "json")
+            else:
+                formatter.format_list(resources)
+        elif format == "csv":
+            if output:
+                formatter.save_to_file(resources, output, "csv")
+            else:
+                formatter.format_list(resources)
+        else:
+            _format_resources_table(resources)
+
+        if output:
+            formatter.print_success(f"Resources information saved to {output}")
+
+    except (ProfileNotFoundError, MissingCredentialsError) as e:
+        formatter.print_error(f"Authentication error: {e}")
+        raise typer.Exit(1)
+    except ValueError as e:
+        formatter.print_error(f"Invalid request: {e}")
+        raise typer.Exit(1)
+    except Exception as e:
+        formatter.print_error(f"Failed to get resources batch: {e}")
+        raise typer.Exit(1)
+
+
+@app.command("get-metadata")
+def get_resource_metadata(
+    resource_rid: str = typer.Argument(
+        ..., help="Resource Identifier", autocompletion=complete_rid
+    ),
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Profile name", autocompletion=complete_profile
+    ),
+    format: str = typer.Option(
+        "table",
+        "--format",
+        "-f",
+        help="Output format (table, json, csv)",
+        autocompletion=complete_output_format,
+    ),
+    output: Optional[str] = typer.Option(
+        None, "--output", "-o", help="Output file path"
+    ),
+):
+    """Get metadata for a specific resource."""
+    try:
+        service = ResourceService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(
+            f"Fetching metadata for {resource_rid}..."
+        ):
+            metadata = service.get_resource_metadata(resource_rid)
+
+        # Format output
+        if format == "json":
+            if output:
+                formatter.save_to_file(metadata, output, "json")
+            else:
+                formatter.format_dict(metadata)
+        elif format == "csv":
+            # Convert metadata dict to list for CSV output
+            metadata_list = [{"key": k, "value": v} for k, v in metadata.items()]
+            if output:
+                formatter.save_to_file(metadata_list, output, "csv")
+            else:
+                formatter.format_list(metadata_list)
+        else:
+            _format_metadata_table(metadata)
+
+        if output:
+            formatter.print_success(f"Resource metadata saved to {output}")
+
+    except (ProfileNotFoundError, MissingCredentialsError) as e:
+        formatter.print_error(f"Authentication error: {e}")
+        raise typer.Exit(1)
+    except Exception as e:
+        formatter.print_error(f"Failed to get resource metadata: {e}")
+        raise typer.Exit(1)
+
+
+@app.command("move")
+def move_resource(
+    resource_rid: str = typer.Argument(
+        ..., help="Resource Identifier", autocompletion=complete_rid
+    ),
+    target_folder_rid: str = typer.Option(
+        ...,
+        "--target-folder",
+        "-t",
+        help="Target folder Resource Identifier",
+        autocompletion=complete_rid,
+    ),
+    profile: Optional[str] = typer.Option(
+        None, "--profile", help="Profile name", autocompletion=complete_profile
+    ),
+    format: str = typer.Option(
+        "table",
+        "--format",
+        "-f",
+        help="Output format (table, json, csv)",
+        autocompletion=complete_output_format,
+    ),
+):
+    """Move a resource to a different folder."""
+    try:
+        service = ResourceService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(
+            f"Moving resource {resource_rid} to {target_folder_rid}..."
+        ):
+            resource = service.move_resource(resource_rid, target_folder_rid)
+
+        formatter.print_success(f"Successfully moved resource to {target_folder_rid}")
+
+        # Format output
+        if format == "json":
+            formatter.format_dict(resource)
+        elif format == "csv":
+            formatter.format_list([resource])
+        else:
+            _format_resource_table(resource)
+
+    except (ProfileNotFoundError, MissingCredentialsError) as e:
+        formatter.print_error(f"Authentication error: {e}")
+        raise typer.Exit(1)
+    except Exception as e:
+        formatter.print_error(f"Failed to move resource: {e}")
+        raise typer.Exit(1)
+
+
+def _format_resource_table(resource: dict):
+    """Format resource information as a table."""
+    table = Table(
+        title="Resource Information", show_header=True, header_style="bold cyan"
+    )
+    table.add_column("Property", style="cyan")
+    table.add_column("Value")
+
+    table.add_row("RID", resource.get("rid", "N/A"))
+    table.add_row("Display Name", resource.get("display_name", "N/A"))
+    table.add_row("Name", resource.get("name", "N/A"))
+    table.add_row("Description", resource.get("description", "N/A"))
+    table.add_row("Type", resource.get("type", "N/A"))
+    table.add_row("Path", resource.get("path", "N/A"))
+    table.add_row("Folder RID", resource.get("folder_rid", "N/A"))
+    table.add_row("Created By", resource.get("created_by", "N/A"))
+    table.add_row("Created Time", resource.get("created_time", "N/A"))
+    table.add_row("Modified By", resource.get("modified_by", "N/A"))
+    table.add_row("Modified Time", resource.get("modified_time", "N/A"))
+    table.add_row("Size (bytes)", resource.get("size_bytes", "N/A"))
+    table.add_row("Trash Status", resource.get("trash_status", "N/A"))
+
+    console.print(table)
+
+
+def _format_resources_table(resources: List[dict]):
+    """Format multiple resources as a table."""
+    table = Table(title="Resources", show_header=True, header_style="bold cyan")
+    table.add_column("Type")
+    table.add_column("Display Name")
+    table.add_column("RID")
+    table.add_column("Folder RID")
+    table.add_column("Created By")
+
+    for resource in resources:
+        table.add_row(
+            resource.get("type", "N/A"),
+            resource.get("display_name") or resource.get("name", "N/A"),
+            resource.get("rid", "N/A"),
+            resource.get("folder_rid", "N/A"),
+            resource.get("created_by", "N/A"),
+        )
+
+    console.print(table)
+    console.print(f"\nTotal: {len(resources)} resources")
+
+
+def _format_metadata_table(metadata: dict):
+    """Format metadata as a table."""
+    table = Table(title="Resource Metadata", show_header=True, header_style="bold cyan")
+    table.add_column("Key", style="cyan")
+    table.add_column("Value")
+
+    for key, value in metadata.items():
+        # Convert complex values to strings
+        value_str = str(value) if value is not None else "N/A"
+        table.add_row(key, value_str)
+
+    console.print(table)
+
+
+@app.callback()
+def main():
+    """
+    Resource operations using foundry-platform-sdk.
+
+    Manage resources in the Foundry filesystem. Get resource information,
+    search resources, manage metadata, and perform operations using Resource
+    Identifiers (RIDs).
+
+    Examples:
+        # Get resource information
+        pltr resource get ri.compass.main.dataset.xyz123
+
+        # List all resources
+        pltr resource list
+
+        # List resources in a specific folder
+        pltr resource list --folder-rid ri.compass.main.folder.abc456
+
+        # List only datasets
+        pltr resource list --type dataset
+
+        # Search for resources
+        pltr resource search "sales data"
+
+        # Search for datasets containing "user"
+        pltr resource search "user" --type dataset
+
+        # Get resource metadata
+        pltr resource get-metadata ri.compass.main.dataset.xyz123
+
+        # Move resource to different folder
+        pltr resource move ri.compass.main.dataset.xyz123 --target-folder ri.compass.main.folder.new456
+    """
+    pass