pltr-cli 0.3.0__tar.gz → 0.4.0__tar.gz

pltr_cli-0.4.0/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.4.0] - 2025-01-31
+
+### Added
+- Comprehensive folder management functionality
+- Preview mode support for folder API operations
+
+### Fixed
+- CI pipeline issues
+- Code style and formatting improvements
+
+## [0.3.0] - 2024-12-XX
+
+### Added
+- Initial release with core CLI functionality
+- Palantir Foundry API integration
+- Command-line interface for data operations
+
+[0.4.0]: https://github.com/anjor/pltr-cli/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/anjor/pltr-cli/releases/tag/v0.3.0

{pltr_cli-0.3.0 → pltr_cli-0.4.0}/CLAUDE.md

@@ -1,6 +1,5 @@
 ## Development tips
 
-Always keep @DEVELOPMENT_PLAN.md up to date.
 The basis of the SDK is https://github.com/palantir/foundry-platform-python . This is a
 CLI that wraps around the SDK to give a CLI interface.
 

{pltr_cli-0.3.0 → pltr_cli-0.4.0}/PKG-INFO

@@ -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 → pltr_cli-0.4.0}/README.md

@@ -1,6 +1,6 @@
 # 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
 
@@ -10,6 +10,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)
@@ -72,6 +73,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"
 
@@ -96,7 +103,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.4.0/children.csv

@@ -0,0 +1,3 @@
+description,display_name,name,rid,type
+A child folder,Child Folder,,ri.compass.main.folder.child-folder,folder
+,Child Dataset,Child Dataset,ri.foundry.main.dataset.child-dataset,dataset

{pltr_cli-0.3.0 → pltr_cli-0.4.0}/docs/user-guide/commands.md

@@ -1,6 +1,6 @@
 # Command Reference
 
-Complete reference for all pltr-cli commands. The CLI provides 65+ commands across 8 major command groups for comprehensive Foundry API access.
+Complete reference for all pltr-cli commands. The CLI provides 70+ commands across 9 major command groups for comprehensive Foundry API access.
 
 ## Global Options
 
@@ -147,6 +147,101 @@ pltr dataset create "Analysis Results" --parent-folder ri.foundry.main.folder.xy
 
 ---
 
+## 📁 Folder Commands
+
+Folder operations for managing the Foundry filesystem structure using the foundry-platform-sdk.
+
+### `pltr folder create [OPTIONS] NAME`
+Create a new folder in Foundry.
+
+**Arguments:**
+- `NAME` (required): Folder display name
+
+**Options:**
+- `--parent-folder`, `-p` TEXT: Parent folder RID [default: ri.compass.main.folder.0 (root)]
+- `--profile` TEXT: Profile name
+- `--format`, `-f` TEXT: Output format (table, json, csv) [default: table]
+
+**Examples:**
+```bash
+# Create folder in root
+pltr folder create "My Project"
+
+# Create folder in specific parent
+pltr folder create "Sub Folder" --parent-folder ri.compass.main.folder.xyz123
+
+# Create with JSON output
+pltr folder create "Analysis" --format json
+```
+
+### `pltr folder get [OPTIONS] FOLDER_RID`
+Get detailed information about a specific folder.
+
+**Arguments:**
+- `FOLDER_RID` (required): Folder Resource Identifier
+
+**Options:**
+- `--profile` TEXT: Profile name
+- `--format`, `-f` TEXT: Output format (table, json, csv) [default: table]
+- `--output`, `-o` TEXT: Output file path
+
+**Examples:**
+```bash
+# Get folder info
+pltr folder get ri.compass.main.folder.abc123
+
+# Export as JSON
+pltr folder get ri.compass.main.folder.abc123 --format json --output folder-info.json
+```
+
+### `pltr folder list [OPTIONS] FOLDER_RID`
+List all child resources of a folder.
+
+**Arguments:**
+- `FOLDER_RID` (required): Folder Resource Identifier (use 'ri.compass.main.folder.0' for root)
+
+**Options:**
+- `--profile` TEXT: Profile name
+- `--format`, `-f` TEXT: Output format (table, json, csv) [default: table]
+- `--output`, `-o` TEXT: Output file path
+- `--page-size` INTEGER: Number of items per page
+
+**Examples:**
+```bash
+# List root folder contents
+pltr folder list ri.compass.main.folder.0
+
+# List with pagination
+pltr folder list ri.compass.main.folder.abc123 --page-size 50
+
+# Export children list
+pltr folder list ri.compass.main.folder.abc123 --format csv --output children.csv
+```
+
+### `pltr folder batch-get [OPTIONS] FOLDER_RIDS...`
+Get multiple folders in a single request (max 1000).
+
+**Arguments:**
+- `FOLDER_RIDS...` (required): Space-separated list of folder Resource Identifiers
+
+**Options:**
+- `--profile` TEXT: Profile name
+- `--format`, `-f` TEXT: Output format (table, json, csv) [default: table]
+- `--output`, `-o` TEXT: Output file path
+
+**Examples:**
+```bash
+# Get multiple folders
+pltr folder batch-get ri.compass.main.folder.abc123 ri.compass.main.folder.def456
+
+# Export batch results
+pltr folder batch-get ri.compass.main.folder.abc123 ri.compass.main.folder.def456 --format json --output folders.json
+```
+
+**Root Folder RID**: `ri.compass.main.folder.0` - Use this as the parent folder RID to create folders in the root directory.
+
+---
+
 ## 🎯 Ontology Commands
 
 Comprehensive ontology operations for interacting with Foundry ontologies.
@@ -584,6 +679,11 @@ pltr sql execute "SELECT * FROM table"     # Run SQL query
 pltr ontology list                         # List ontologies
 pltr dataset get <rid>                     # Get dataset info
 
+# Folder Management
+pltr folder create "My Folder"             # Create folder
+pltr folder list ri.compass.main.folder.0  # List root contents
+pltr folder get <folder-rid>               # Get folder info
+
 # Admin
 pltr admin user current                    # Current user info
 pltr admin user list                       # List users

{pltr_cli-0.3.0 → pltr_cli-0.4.0}/docs/user-guide/quick-start.md

@@ -39,7 +39,7 @@ pltr-cli needs to authenticate with your Foundry instance. You have two options:
 If you have a Foundry API token:
 
 ```bash
-pltr configure
+pltr configure configure
 ```
 
 Follow the prompts to enter:

pltr_cli-0.4.0/folder_info.json

@@ -0,0 +1,9 @@
+{
+  "rid": "ri.compass.main.folder.test-folder",
+  "display_name": "Test Folder",
+  "description": "Test folder description",
+  "parent_folder_rid": "ri.compass.main.folder.parent",
+  "created": "2024-01-01T00:00:00Z",
+  "modified": "2024-01-02T00:00:00Z",
+  "type": "folder"
+}

pltr_cli-0.4.0/folders.json

@@ -0,0 +1,11 @@
+[
+  {
+    "rid": "ri.compass.main.folder.test-folder",
+    "display_name": "Test Folder",
+    "description": "Test folder description",
+    "parent_folder_rid": "ri.compass.main.folder.parent",
+    "created": "2024-01-01T00:00:00Z",
+    "modified": "2024-01-02T00:00:00Z",
+    "type": "folder"
+  }
+]

{pltr_cli-0.3.0 → pltr_cli-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pltr-cli"
-version = "0.3.0"
+version = "0.4.0"
 description = "Command-line interface for Palantir Foundry APIs"
 authors = [
     { name = "anjor", email = "anjor@umd.edu" }

{pltr_cli-0.3.0 → pltr_cli-0.4.0}/src/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_cli-0.4.0/src/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