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

pltr/cli.py

@@ -10,6 +10,7 @@ from pltr.commands import (
     configure,
     verify,
     dataset,
+    folder,
     ontology,
     sql,
     admin,
@@ -28,6 +29,7 @@ app = typer.Typer(
 app.add_typer(configure.app, name="configure", help="Manage authentication profiles")
 app.add_typer(verify.app, name="verify", help="Verify authentication")
 app.add_typer(dataset.app, name="dataset", help="Manage datasets")
+app.add_typer(folder.app, name="folder", help="Manage folders")
 app.add_typer(ontology.app, name="ontology", help="Ontology operations")
 app.add_typer(sql.app, name="sql", help="Execute SQL queries")
 app.add_typer(

pltr/commands/folder.py

@@ -0,0 +1,338 @@
+"""
+Folder management commands for Foundry filesystem.
+"""
+
+import typer
+from typing import Optional, List
+from rich.console import Console
+from rich.table import Table
+
+from ..services.folder import FolderService
+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("create")
+def create_folder(
+    name: str = typer.Argument(..., help="Folder display name"),
+    parent_folder: str = typer.Option(
+        "ri.compass.main.folder.0",
+        "--parent-folder",
+        "-p",
+        help="Parent folder RID (default: root folder)",
+        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,
+    ),
+):
+    """Create a new folder in Foundry."""
+    try:
+        service = FolderService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(f"Creating folder '{name}'..."):
+            folder = service.create_folder(
+                display_name=name, parent_folder_rid=parent_folder
+            )
+
+        # Cache the RID for future completions
+        if folder.get("rid"):
+            cache_rid(folder["rid"])
+
+        formatter.print_success(f"Successfully created folder '{name}'")
+        formatter.print_info(f"Folder RID: {folder.get('rid', 'unknown')}")
+
+        # Format output
+        if format == "json":
+            formatter.format_dict(folder)
+        elif format == "csv":
+            formatter.format_list([folder])
+        else:
+            _format_folder_table(folder)
+
+    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 create folder: {e}")
+        raise typer.Exit(1)
+
+
+@app.command("get")
+def get_folder(
+    folder_rid: str = typer.Argument(
+        ..., help="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,
+    ),
+    output: Optional[str] = typer.Option(
+        None, "--output", "-o", help="Output file path"
+    ),
+):
+    """Get detailed information about a specific folder."""
+    try:
+        # Cache the RID for future completions
+        cache_rid(folder_rid)
+
+        service = FolderService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(f"Fetching folder {folder_rid}..."):
+            folder = service.get_folder(folder_rid)
+
+        # Format output
+        if format == "json":
+            if output:
+                formatter.save_to_file(folder, output, "json")
+            else:
+                formatter.format_dict(folder)
+        elif format == "csv":
+            if output:
+                formatter.save_to_file([folder], output, "csv")
+            else:
+                formatter.format_list([folder])
+        else:
+            _format_folder_table(folder)
+
+        if output:
+            formatter.print_success(f"Folder 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 folder: {e}")
+        raise typer.Exit(1)
+
+
+@app.command("list")
+def list_children(
+    folder_rid: str = typer.Argument(
+        ...,
+        help="Folder Resource Identifier (use 'ri.compass.main.folder.0' for root)",
+        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"
+    ),
+    page_size: Optional[int] = typer.Option(
+        None, "--page-size", help="Number of items per page"
+    ),
+):
+    """List all child resources of a folder."""
+    try:
+        # Cache the RID for future completions
+        cache_rid(folder_rid)
+
+        service = FolderService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(
+            f"Listing children of folder {folder_rid}..."
+        ):
+            children = service.list_children(folder_rid, page_size=page_size)
+
+        if not children:
+            formatter.print_info("No children found in this folder.")
+            return
+
+        # Format output
+        if format == "json":
+            if output:
+                formatter.save_to_file(children, output, "json")
+            else:
+                formatter.format_list(children)
+        elif format == "csv":
+            if output:
+                formatter.save_to_file(children, output, "csv")
+            else:
+                formatter.format_list(children)
+        else:
+            _format_children_table(children)
+
+        if output:
+            formatter.print_success(f"Folder children 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 folder children: {e}")
+        raise typer.Exit(1)
+
+
+@app.command("batch-get")
+def get_folders_batch(
+    folder_rids: List[str] = typer.Argument(
+        ..., help="Folder 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 folders in a single request (max 1000)."""
+    try:
+        service = FolderService(profile=profile)
+
+        with SpinnerProgressTracker().track_spinner(
+            f"Fetching {len(folder_rids)} folders..."
+        ):
+            folders = service.get_folders_batch(folder_rids)
+
+        # Cache RIDs for future completions
+        for folder in folders:
+            if folder.get("rid"):
+                cache_rid(folder["rid"])
+
+        # Format output
+        if format == "json":
+            if output:
+                formatter.save_to_file(folders, output, "json")
+            else:
+                formatter.format_list(folders)
+        elif format == "csv":
+            if output:
+                formatter.save_to_file(folders, output, "csv")
+            else:
+                formatter.format_list(folders)
+        else:
+            _format_folders_batch_table(folders)
+
+        if output:
+            formatter.print_success(f"Folders 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 folders batch: {e}")
+        raise typer.Exit(1)
+
+
+def _format_folder_table(folder: dict):
+    """Format folder information as a table."""
+    table = Table(
+        title="Folder Information", show_header=True, header_style="bold cyan"
+    )
+    table.add_column("Property", style="cyan")
+    table.add_column("Value")
+
+    table.add_row("RID", folder.get("rid", "N/A"))
+    table.add_row("Display Name", folder.get("display_name", "N/A"))
+    table.add_row("Description", folder.get("description", "N/A"))
+    table.add_row("Parent Folder", folder.get("parent_folder_rid", "N/A"))
+    table.add_row("Created", folder.get("created", "N/A"))
+    table.add_row("Modified", folder.get("modified", "N/A"))
+
+    console.print(table)
+
+
+def _format_children_table(children: List[dict]):
+    """Format folder children as a table."""
+    table = Table(title="Folder Children", show_header=True, header_style="bold cyan")
+    table.add_column("Type", style="cyan")
+    table.add_column("Display Name")
+    table.add_column("RID")
+
+    for child in children:
+        table.add_row(
+            child.get("type", "unknown"),
+            child.get("display_name", child.get("name", "N/A")),
+            child.get("rid", "N/A"),
+        )
+
+    console.print(table)
+    console.print(f"\nTotal: {len(children)} items")
+
+
+def _format_folders_batch_table(folders: List[dict]):
+    """Format multiple folders as a table."""
+    table = Table(title="Folders", show_header=True, header_style="bold cyan")
+    table.add_column("Display Name")
+    table.add_column("RID")
+    table.add_column("Parent Folder")
+    table.add_column("Description")
+
+    for folder in folders:
+        table.add_row(
+            folder.get("display_name", "N/A"),
+            folder.get("rid", "N/A"),
+            folder.get("parent_folder_rid", "N/A"),
+            folder.get("description", "N/A") or "",
+        )
+
+    console.print(table)
+    console.print(f"\nTotal: {len(folders)} folders")
+
+
+@app.callback()
+def main():
+    """
+    Folder operations using foundry-platform-sdk.
+
+    Manage folders in the Foundry filesystem. Create, retrieve, and list
+    folder contents using Resource Identifiers (RIDs).
+
+    The root folder RID is: ri.compass.main.folder.0
+
+    Examples:
+        # Create a folder in root
+        pltr folder create "My Folder"
+
+        # Create a folder in a specific parent
+        pltr folder create "Sub Folder" --parent-folder ri.compass.main.folder.xyz123
+
+        # List root folder contents
+        pltr folder list ri.compass.main.folder.0
+
+        # Get folder information
+        pltr folder get ri.compass.main.folder.xyz123
+    """
+    pass

pltr/services/folder.py

@@ -0,0 +1,167 @@
+"""
+Folder service wrapper for Foundry SDK filesystem API.
+"""
+
+from typing import Any, Optional, Dict, List
+
+from .base import BaseService
+
+
+class FolderService(BaseService):
+    """Service wrapper for Foundry folder operations using filesystem API."""
+
+    def _get_service(self) -> Any:
+        """Get the Foundry filesystem service."""
+        return self.client.filesystem
+
+    def create_folder(
+        self, display_name: str, parent_folder_rid: str
+    ) -> Dict[str, Any]:
+        """
+        Create a new folder.
+
+        Args:
+            display_name: Folder display name
+            parent_folder_rid: Parent folder RID (use 'ri.compass.main.folder.0' for root)
+
+        Returns:
+            Created folder information
+        """
+        try:
+            folder = self.service.Folder.create(
+                display_name=display_name,
+                parent_folder_rid=parent_folder_rid,
+                preview=True,
+            )
+            return self._format_folder_info(folder)
+        except Exception as e:
+            raise RuntimeError(f"Failed to create folder '{display_name}': {e}")
+
+    def get_folder(self, folder_rid: str) -> Dict[str, Any]:
+        """
+        Get information about a specific folder.
+
+        Args:
+            folder_rid: Folder Resource Identifier
+
+        Returns:
+            Folder information dictionary
+        """
+        try:
+            folder = self.service.Folder.get(folder_rid, preview=True)
+            return self._format_folder_info(folder)
+        except Exception as e:
+            raise RuntimeError(f"Failed to get folder {folder_rid}: {e}")
+
+    def list_children(
+        self,
+        folder_rid: str,
+        page_size: Optional[int] = None,
+        page_token: Optional[str] = None,
+    ) -> List[Dict[str, Any]]:
+        """
+        List all child resources of a folder.
+
+        Args:
+            folder_rid: Folder Resource Identifier
+            page_size: Number of items per page (optional)
+            page_token: Pagination token (optional)
+
+        Returns:
+            List of child resources
+        """
+        try:
+            children = []
+            # The children method returns an iterator
+            for child in self.service.Folder.children(
+                folder_rid, page_size=page_size, page_token=page_token, preview=True
+            ):
+                children.append(self._format_resource_info(child))
+            return children
+        except Exception as e:
+            raise RuntimeError(f"Failed to list children of folder {folder_rid}: {e}")
+
+    def get_folders_batch(self, folder_rids: List[str]) -> List[Dict[str, Any]]:
+        """
+        Get multiple folders in a single request.
+
+        Args:
+            folder_rids: List of folder RIDs (max 1000)
+
+        Returns:
+            List of folder information dictionaries
+        """
+        if len(folder_rids) > 1000:
+            raise ValueError("Maximum batch size is 1000 folders")
+
+        try:
+            response = self.service.Folder.get_batch(body=folder_rids, preview=True)
+            folders = []
+            for folder in response.folders:
+                folders.append(self._format_folder_info(folder))
+            return folders
+        except Exception as e:
+            raise RuntimeError(f"Failed to get folders batch: {e}")
+
+    def _format_folder_info(self, folder: Any) -> Dict[str, Any]:
+        """
+        Format folder information for consistent output.
+
+        Args:
+            folder: Folder object from Foundry SDK
+
+        Returns:
+            Formatted folder information dictionary
+        """
+        return {
+            "rid": getattr(folder, "rid", None),
+            "display_name": getattr(folder, "display_name", None),
+            "description": getattr(folder, "description", None),
+            "created": self._format_timestamp(getattr(folder, "created", None)),
+            "modified": self._format_timestamp(getattr(folder, "modified", None)),
+            "parent_folder_rid": getattr(folder, "parent_folder_rid", None),
+            "type": "folder",
+        }
+
+    def _format_resource_info(self, resource: Any) -> Dict[str, Any]:
+        """
+        Format resource information (can be folder, dataset, etc.).
+
+        Args:
+            resource: Resource object from Foundry SDK
+
+        Returns:
+            Formatted resource information dictionary
+        """
+        resource_type = getattr(resource, "type", "unknown")
+        base_info = {
+            "rid": getattr(resource, "rid", None),
+            "display_name": getattr(resource, "display_name", None),
+            "type": resource_type,
+        }
+
+        # Add type-specific fields
+        if resource_type == "folder":
+            base_info["description"] = getattr(resource, "description", None)
+        elif resource_type == "dataset":
+            base_info["name"] = getattr(resource, "name", None)
+
+        return base_info
+
+    def _format_timestamp(self, timestamp: Any) -> Optional[str]:
+        """
+        Format timestamp for display.
+
+        Args:
+            timestamp: Timestamp object from SDK
+
+        Returns:
+            Formatted timestamp string or None
+        """
+        if timestamp is None:
+            return None
+
+        # Handle different timestamp formats from the SDK
+        if hasattr(timestamp, "time"):
+            return str(timestamp.time)
+        return str(timestamp)

{pltr_cli-0.3.0.dist-info → pltr_cli-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pltr-cli
-Version: 0.3.0
+Version: 0.4.0
 Summary: Command-line interface for Palantir Foundry APIs
 Project-URL: Homepage, https://github.com/anjor/pltr-cli
 Project-URL: Repository, https://github.com/anjor/pltr-cli
@@ -37,7 +37,7 @@ Description-Content-Type: text/markdown
 
 # pltr-cli
 
-A comprehensive command-line interface for Palantir Foundry APIs, providing 65+ commands for data analysis, ontology operations, SQL queries, and administrative tasks.
+A comprehensive command-line interface for Palantir Foundry APIs, providing 70+ commands for data analysis, ontology operations, SQL queries, folder management, and administrative tasks.
 
 ## Overview
 
@@ -47,6 +47,7 @@ A comprehensive command-line interface for Palantir Foundry APIs, providing 65+
 
 - 🔐 **Secure Authentication**: Token and OAuth2 support with encrypted credential storage
 - 📊 **Dataset Operations**: Get dataset information and create new datasets (RID-based API)
+- 📁 **Folder Management**: Create, explore, and manage Foundry filesystem structure
 - 🎯 **Comprehensive Ontology Access**: 13 commands for objects, actions, and queries
 - 📝 **Full SQL Support**: Execute, submit, monitor, and export query results
 - 👥 **Admin Operations**: User, group, role, and organization management (16 commands)
@@ -109,6 +110,12 @@ pltr admin user current
 # List available ontologies
 pltr ontology list
 
+# Create a new folder
+pltr folder create "My Project"
+
+# List root folder contents
+pltr folder list ri.compass.main.folder.0
+
 # Execute a simple SQL query
 pltr sql execute "SELECT 1 as test"
 
@@ -133,7 +140,7 @@ pltr-cli provides comprehensive documentation to help you get the most out of th
 ### 📖 User Guides
 - **[Quick Start Guide](docs/user-guide/quick-start.md)** - Get up and running in 5 minutes
 - **[Authentication Setup](docs/user-guide/authentication.md)** - Complete guide to token and OAuth2 setup
-- **[Command Reference](docs/user-guide/commands.md)** - Complete reference for all 65+ commands
+- **[Command Reference](docs/user-guide/commands.md)** - Complete reference for all 70+ commands
 - **[Common Workflows](docs/user-guide/workflows.md)** - Real-world data analysis patterns
 - **[Troubleshooting](docs/user-guide/troubleshooting.md)** - Solutions to common issues
 

{pltr_cli-0.3.0.dist-info → pltr_cli-0.4.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 pltr/__init__.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
 pltr/__main__.py,sha256=HWJ49UoAYBQCf8kjuySPmBTuUjTZrOx-y6PzMTyS1KE,879
-pltr/cli.py,sha256=Kb9237LDITTX1VU-X-O5eKn8dXKI0R28HokYXGGklNU,1879
+pltr/cli.py,sha256=cogkxi-J2hKrWKzjRFy6GLvcsPfrE_r_pAG6EMmuJ8s,1955
 pltr/auth/__init__.py,sha256=G0V-Rh25FaJsH2nhrf146XQQG_ApdbyPJNuHJC25kgk,38
 pltr/auth/base.py,sha256=LvmCwS7A0q0CITcym8udPzdACL52_jSGusiaeCTOaE8,981
 pltr/auth/manager.py,sha256=ZqlGefr1a8MGx0g7kkQhpmiuVp0XTg3f43yMBCk-IRo,4305
@@ -13,6 +13,7 @@ pltr/commands/alias.py,sha256=r9xMsQNrGvaixSlspzoO2IXQ44LFXuZM4itt8vC0dRc,6862
 pltr/commands/completion.py,sha256=YTxaRL4-rDs5n7aXf3ogFsxbHVJUBo_HiBbd0fbBPZ0,10870
 pltr/commands/configure.py,sha256=oYj-VlOEj3MDwtB2RC4bYOYzI_sXTanPnz7y1GmMTqY,4800
 pltr/commands/dataset.py,sha256=BCYfaBpLji5wasOiH_jOqO-JC9ScfJhodox9kl9W2Cw,3609
+pltr/commands/folder.py,sha256=IAPPA3Smk1IWqThneEtZ08Zp79vDKVUabSkL_nDvUWk,10679
 pltr/commands/ontology.py,sha256=zUgSrmv8xi26SQK7GsM3qusgR9Wuka0GyzE7L8DkduE,18317
 pltr/commands/shell.py,sha256=QLF7TEGpaau9i0A9s3VjnegvtHde-SLRqI4suJFT4WI,3622
 pltr/commands/sql.py,sha256=wol0Rlvi_RplCFbOg4LCa3VXsOqmRZdFFVv7V6iVkh8,12602
@@ -27,6 +28,7 @@ pltr/services/base.py,sha256=R2G781FI-sXtjUyLd91bVnmLb4cYZI3G8U5ndR9NLA4,1593
 pltr/services/dataset.py,sha256=W3zoh-9YIJ6HBsDijejVEngKvpudFoZinYtHDmAXCOc,2785
 pltr/services/dataset_full.py,sha256=FyMiwOSyX1cUrYXaK0T_1iq5G_X0e5iZTibJHuEmMeE,9869
 pltr/services/dataset_v2.py,sha256=_uhcVJ91w_Y07glceqHceccAwPWr6q1TWSIqcP1FU8I,4259
+pltr/services/folder.py,sha256=mWElyvn-wXPB5sv8Ik_dLeW5JM6jZg3g9KKBk6UcrlQ,5389
 pltr/services/ontology.py,sha256=iW7qRK8ptlw-u4eAwLNC-mdzLoLZzh7SRqJyok2c3GU,14883
 pltr/services/sql.py,sha256=19cscjlzN8WE1s8_ctiRcrOvMzCfmWRj49vjJ8Gs5Q4,11286
 pltr/utils/__init__.py,sha256=DF7TigL1XbKVGM5VjgU8_8AGIszofkdO80oCzLGGnTE,38
@@ -34,8 +36,8 @@ pltr/utils/alias_resolver.py,sha256=DIF7P1UnUU8kqocJfIDEWjYq4s8_0KfqRZBbECeZEh8,
 pltr/utils/completion.py,sha256=bjeqjleEfB2YcQFpcxvF0GoQ763F6KBbULSZC4FWY_g,4980
 pltr/utils/formatting.py,sha256=Ptv7obiB7uWNf5YTiY4rUAKmabO5UGnwLocSfLplrZ0,18552
 pltr/utils/progress.py,sha256=BKYbiLO61uhQbibabU7pxvvbAWMRLRmqk4pZldBQK_g,9053
-pltr_cli-0.3.0.dist-info/METADATA,sha256=BVT_zd9ZrK811JeMXPR_IX1S3-ahE3lhk6q2QiNdbFA,8864
-pltr_cli-0.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pltr_cli-0.3.0.dist-info/entry_points.txt,sha256=8tvEcW04kA_oAE2Dwwu-Og9efjl4ESJvs4AzlP2KBdQ,38
-pltr_cli-0.3.0.dist-info/licenses/LICENSE,sha256=6VUFd_ytnOBD2O1tmkKrA-smigi9QEhYr_tge4h4z8Y,1070
-pltr_cli-0.3.0.dist-info/RECORD,,
+pltr_cli-0.4.0.dist-info/METADATA,sha256=RDHEVijMZLcjzM8fBjaNm8DQsY0PIK8339CbDK64s-s,9096
+pltr_cli-0.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pltr_cli-0.4.0.dist-info/entry_points.txt,sha256=8tvEcW04kA_oAE2Dwwu-Og9efjl4ESJvs4AzlP2KBdQ,38
+pltr_cli-0.4.0.dist-info/licenses/LICENSE,sha256=6VUFd_ytnOBD2O1tmkKrA-smigi9QEhYr_tge4h4z8Y,1070
+pltr_cli-0.4.0.dist-info/RECORD,,