pltr-cli 0.1.2__py3-none-any.whl → 0.2.0__py3-none-any.whl

pltr/utils/formatting.py

@@ -329,3 +329,211 @@ class OutputFormatter:
     def print_info(self, message: str):
         """Print info message with formatting."""
         self.console.print(f"ℹ️  {message}", style="blue")
+
+    def format_table(
+        self,
+        data: List[Dict[str, Any]],
+        columns: Optional[List[str]] = None,
+        format: str = "table",
+        output: Optional[str] = None,
+    ) -> Optional[str]:
+        """
+        Format data as a table with specified columns.
+
+        Args:
+            data: List of dictionaries to format
+            columns: List of column names to display (uses all if None)
+            format: Output format ('table', 'json', 'csv')
+            output: Optional output file path
+
+        Returns:
+            Formatted string if no output file specified
+        """
+        if columns:
+            # Filter data to only include specified columns
+            filtered_data = []
+            for item in data:
+                filtered_item = {col: item.get(col) for col in columns}
+                filtered_data.append(filtered_item)
+            data = filtered_data
+
+        return self.format_output(data, format, output)
+
+    def format_list(
+        self,
+        data: List[Any],
+        format: str = "table",
+        output: Optional[str] = None,
+    ) -> Optional[str]:
+        """
+        Format a list of items.
+
+        Args:
+            data: List of items to format
+            format: Output format ('table', 'json', 'csv')
+            output: Optional output file path
+
+        Returns:
+            Formatted string if no output file specified
+        """
+        # Convert list items to dicts if needed
+        if data and not isinstance(data[0], dict):
+            data = [{"value": item} for item in data]
+
+        return self.format_output(data, format, output)
+
+    def format_dict(
+        self,
+        data: Dict[str, Any],
+        format: str = "table",
+        output: Optional[str] = None,
+    ) -> Optional[str]:
+        """
+        Format a dictionary for display.
+
+        Args:
+            data: Dictionary to format
+            format: Output format ('table', 'json', 'csv')
+            output: Optional output file path
+
+        Returns:
+            Formatted string if no output file specified
+        """
+        if format == "table":
+            # Convert to key-value pairs for table display
+            table_data = [{"Property": k, "Value": str(v)} for k, v in data.items()]
+            return self.format_output(table_data, format, output)
+        else:
+            return self.format_output(data, format, output)
+
+    def display(self, data: Any, format_type: str = "table") -> None:
+        """
+        Display data using the appropriate formatter.
+
+        Args:
+            data: Data to display
+            format_type: Display format ('table', 'json', 'csv')
+        """
+        if isinstance(data, list):
+            if data and isinstance(data[0], dict):
+                self.format_output(data, format_type)
+            else:
+                self.format_list(data, format_type)
+        elif isinstance(data, dict):
+            self.format_dict(data, format_type)
+        else:
+            # For simple values, just print them
+            if format_type == "json":
+                rich_print(json.dumps(data, indent=2, default=str))
+            else:
+                rich_print(str(data))
+
+    def save_to_file(self, data: Any, file_path: Any, format_type: str) -> None:
+        """
+        Save data to a file in the specified format.
+
+        Args:
+            data: Data to save
+            file_path: Path object or string for output file
+            format_type: File format ('table', 'json', 'csv')
+        """
+        file_path_str = str(file_path)
+
+        if isinstance(data, list):
+            if data and isinstance(data[0], dict):
+                self.format_output(data, format_type, file_path_str)
+            else:
+                self.format_list(data, format_type, file_path_str)
+        elif isinstance(data, dict):
+            self.format_dict(data, format_type, file_path_str)
+        else:
+            # For simple values, save as text
+            with open(file_path_str, "w") as f:
+                if format_type == "json":
+                    json.dump(data, f, indent=2, default=str)
+                else:
+                    f.write(str(data))
+
+    def format_sql_results(
+        self,
+        results: Any,
+        format_type: str = "table",
+        output_file: Optional[str] = None,
+    ) -> Optional[str]:
+        """
+        Format SQL query results for display.
+
+        Args:
+            results: Query results (could be dict, list, or other types)
+            format_type: Output format ('table', 'json', 'csv')
+            output_file: Optional output file path
+
+        Returns:
+            Formatted string if no output file specified
+        """
+        # Handle different types of SQL results
+        if isinstance(results, dict):
+            # Check for special result types
+            if "text" in results:
+                # Text result - display as-is
+                text_data = results["text"]
+                if output_file:
+                    with open(output_file, "w") as f:
+                        f.write(text_data)
+                    return None
+                else:
+                    rich_print(text_data)
+                    return text_data
+            elif "type" in results and results["type"] == "binary":
+                # Binary result - show metadata
+                return self.format_output(results, format_type, output_file)
+            elif "results" in results:
+                # Results array
+                return self.format_output(results["results"], format_type, output_file)
+            elif "result" in results:
+                # Single result
+                single_result = results["result"]
+                if isinstance(single_result, (dict, list)):
+                    return self.format_output(single_result, format_type, output_file)
+                else:
+                    # Simple value
+                    display_data = [{"Result": single_result}]
+                    return self.format_output(display_data, format_type, output_file)
+            else:
+                # Regular dictionary
+                return self.format_dict(results, format_type, output_file)
+        elif isinstance(results, list):
+            # List of results
+            return self.format_output(results, format_type, output_file)
+        else:
+            # Simple value
+            display_data = [{"Result": results}]
+            return self.format_output(display_data, format_type, output_file)
+
+    def format_query_status(
+        self,
+        status_info: Dict[str, Any],
+        format_type: str = "table",
+        output_file: Optional[str] = None,
+    ) -> Optional[str]:
+        """
+        Format query status information.
+
+        Args:
+            status_info: Query status dictionary
+            format_type: Output format ('table', 'json', 'csv')
+            output_file: Optional output file path
+
+        Returns:
+            Formatted string if no output file specified
+        """
+        if format_type == "table":
+            # Convert to key-value display for better readability
+            display_data = []
+            for key, value in status_info.items():
+                display_data.append(
+                    {"Property": key.replace("_", " ").title(), "Value": str(value)}
+                )
+            return self.format_output(display_data, format_type, output_file)
+        else:
+            return self.format_output(status_info, format_type, output_file)

pltr/utils/progress.py

@@ -310,7 +310,7 @@ with tracker.track_upload("data.csv") as progress:
         # ... upload chunk ...
         progress(len(chunk))
 
-# File download with progress  
+# File download with progress
 tracker = with_download_progress()
 with tracker.track_download("output.csv", total_size=1024000) as progress:
     # Download file

pltr_cli-0.2.0.dist-info/METADATA

@@ -0,0 +1,280 @@
+Metadata-Version: 2.4
+Name: pltr-cli
+Version: 0.2.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
+Project-URL: Issues, https://github.com/anjor/pltr-cli/issues
+Project-URL: Changelog, https://github.com/anjor/pltr-cli/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/anjor/pltr-cli/blob/main/README.md
+Author-email: anjor <anjor@umd.edu>
+License: MIT
+License-File: LICENSE
+Keywords: api,cli,data,foundry,ontology,palantir
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Requires-Dist: click-repl>=0.3.0
+Requires-Dist: foundry-platform-sdk>=1.27.0
+Requires-Dist: keyring>=25.6.0
+Requires-Dist: python-dotenv>=1.1.1
+Requires-Dist: requests>=2.32.4
+Requires-Dist: rich>=14.1.0
+Requires-Dist: typer>=0.16.0
+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.
+
+## Overview
+
+`pltr-cli` provides a powerful and intuitive way to interact with Palantir Foundry from the command line. Built on top of the official `foundry-platform-sdk`, it offers comprehensive access to Foundry's capabilities with a focus on productivity and ease of use.
+
+## ✨ Key Features
+
+- 🔐 **Secure Authentication**: Token and OAuth2 support with encrypted credential storage
+- 📊 **Dataset Operations**: Get dataset information and create new datasets (RID-based API)
+- 🎯 **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)
+- 💻 **Interactive Shell**: REPL mode with tab completion and command history
+- ⚡ **Shell Completion**: Auto-completion for bash, zsh, and fish
+- 🎨 **Rich Output**: Beautiful terminal formatting with multiple export formats (table, JSON, CSV)
+- 👤 **Multi-Profile Support**: Manage multiple Foundry environments seamlessly
+
+## Installation
+
+### Using pip
+
+```bash
+pip install pltr-cli
+```
+
+### From source
+
+```bash
+# Clone the repository
+git clone https://github.com/anjor/pltr-cli.git
+cd pltr-cli
+
+# Install with uv
+uv sync
+
+# Run the CLI
+uv run pltr --help
+```
+
+## 🚀 Quick Start
+
+### 1. Configure Authentication
+
+Set up your Foundry credentials:
+
+```bash
+pltr configure configure
+```
+
+Follow the interactive prompts to enter:
+- Foundry hostname (e.g., `foundry.company.com`)
+- Authentication method (token or OAuth2)
+- Your credentials
+
+### 2. Verify Connection
+
+Test your setup:
+
+```bash
+pltr verify
+```
+
+### 3. Start Exploring
+
+```bash
+# Check current user
+pltr admin user current
+
+# List available ontologies
+pltr ontology list
+
+# Execute a simple SQL query
+pltr sql execute "SELECT 1 as test"
+
+# Start interactive mode for exploration
+pltr shell
+```
+
+### 4. Enable Shell Completion
+
+For the best experience:
+
+```bash
+pltr completion install
+```
+
+📖 **Need more help?** See the **[Quick Start Guide](docs/user-guide/quick-start.md)** for detailed setup instructions.
+
+## 📚 Documentation
+
+pltr-cli provides comprehensive documentation to help you get the most out of the tool:
+
+### 📖 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
+- **[Common Workflows](docs/user-guide/workflows.md)** - Real-world data analysis patterns
+- **[Troubleshooting](docs/user-guide/troubleshooting.md)** - Solutions to common issues
+
+### 🔧 Developer Resources
+- **[API Wrapper Documentation](docs/api/wrapper.md)** - Architecture and extension guide
+- **[Examples Gallery](docs/examples/gallery.md)** - Real-world use cases and automation scripts
+
+### 🎯 Quick Command Overview
+
+**Most Common Commands:**
+```bash
+# Authentication & Setup
+pltr configure configure        # Set up authentication
+pltr verify                    # Test connection
+
+# Data Analysis
+pltr sql execute "SELECT * FROM table"  # Run SQL queries
+pltr ontology list             # List ontologies
+pltr dataset get <rid>         # Get dataset info
+
+# Administrative
+pltr admin user current        # Current user info
+pltr admin user list          # List users
+
+# Interactive & Tools
+pltr shell                    # Interactive mode
+pltr completion install       # Enable tab completion
+```
+
+💡 **Tip**: Use `pltr --help` or `pltr <command> --help` for detailed command help.
+
+For the complete command reference with examples, see **[Command Reference](docs/user-guide/commands.md)**.
+
+## ⚙️ Configuration
+
+pltr-cli stores configuration securely using industry best practices:
+
+- **Profile Configuration**: `~/.config/pltr/profiles.json`
+- **Credentials**: Encrypted in system keyring (never stored in plain text)
+- **Shell History**: `~/.config/pltr/repl_history` (for interactive mode)
+
+### Environment Variables
+
+For CI/CD and automation, use environment variables:
+
+```bash
+# Token authentication
+export FOUNDRY_TOKEN="your-api-token"
+export FOUNDRY_HOST="foundry.company.com"
+
+# OAuth2 authentication
+export FOUNDRY_CLIENT_ID="your-client-id"
+export FOUNDRY_CLIENT_SECRET="your-client-secret"
+export FOUNDRY_HOST="foundry.company.com"
+```
+
+See **[Authentication Setup](docs/user-guide/authentication.md)** for complete configuration options.
+
+## 🔧 Development
+
+### Prerequisites
+
+- Python 3.9+
+- [uv](https://github.com/astral-sh/uv) for dependency management
+
+### Quick Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/anjor/pltr-cli.git
+cd pltr-cli
+
+# Install dependencies and development tools
+uv sync
+
+# Install pre-commit hooks
+uv run pre-commit install
+
+# Run tests
+uv run pytest
+
+# Run linting and formatting
+uv run ruff check src/
+uv run ruff format src/
+uv run mypy src/
+```
+
+### Project Architecture
+
+pltr-cli uses a layered architecture:
+
+- **CLI Layer** (Typer): Command-line interface and argument parsing
+- **Command Layer**: Command implementations with validation
+- **Service Layer**: Business logic and foundry-platform-sdk integration
+- **Auth Layer**: Secure authentication and credential management
+- **Utils Layer**: Formatting, progress, and helper functions
+
+See **[API Wrapper Documentation](docs/api/wrapper.md)** for detailed architecture information and extension guides.
+
+## 📊 Current Status
+
+pltr-cli is **production-ready** with comprehensive features:
+
+- ✅ **65+ Commands** across 8 command groups
+- ✅ **273 Unit Tests** with 67% code coverage
+- ✅ **Published on PyPI** with automated releases
+- ✅ **Cross-Platform** support (Windows, macOS, Linux)
+- ✅ **Comprehensive Documentation** (Quick start, guides, examples)
+- ✅ **Interactive Shell** with tab completion and history
+- ✅ **CI/CD Ready** with environment variable support
+
+**Latest Release**: Available on [PyPI](https://pypi.org/project/pltr-cli/)
+
+## 🤝 Contributing
+
+Contributions are welcome! Whether you're fixing bugs, adding features, or improving documentation.
+
+### Getting Started
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Make your changes following the existing patterns
+4. Add tests for new functionality
+5. Run the test suite and linting
+6. Commit using conventional commit format (`feat:`, `fix:`, `docs:`, etc.)
+7. Push to your branch and create a Pull Request
+
+### Development Guidelines
+
+- Follow existing code patterns and architecture
+- Add tests for new functionality
+- Update documentation for user-facing changes
+- Use type hints throughout
+- Follow the existing error handling patterns
+
+See **[API Wrapper Documentation](docs/api/wrapper.md)** for detailed development guidelines.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Acknowledgments
+
+Built on top of the official [Palantir Foundry Platform Python SDK](https://github.com/palantir/foundry-platform-python).

pltr_cli-0.2.0.dist-info/RECORD

@@ -0,0 +1,38 @@
+pltr/__init__.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+pltr/__main__.py,sha256=PQIEddxNh3RNfW-pW0DFDgH2r_RptnKvgBcF9N4S5ik,742
+pltr/cli.py,sha256=lJU7EMPjHkaehA32CJh3d6zUNF8iEGHqGX-K45ErqhU,1798
+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
+pltr/auth/oauth.py,sha256=uTl5T3MSPlq8Jb3c45hib0vj-GQoyLxmS_NbnKez5dI,2844
+pltr/auth/storage.py,sha256=C7I3-22CJcnrKGNdxk9nXjphsnqQVguT5gNfAnR78Ok,2474
+pltr/auth/token.py,sha256=V48kxGn7CFbNGo17er5oI_ZA3xJ3iS9TsFjphZYqS2s,1925
+pltr/commands/__init__.py,sha256=iOLJ1ql4mz-3-4nz21hAqjd-9IjpYAIxr9SJQKHNFxM,29
+pltr/commands/admin.py,sha256=foscSO-QuH6uggUR5Rmv9pTqGjEXTUzpmMFj2-8hEJs,17065
+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/ontology.py,sha256=3MwGsRgCzOsG5OTo0xu1iNa3tpZy64e_Fy3O8I45_5I,18587
+pltr/commands/shell.py,sha256=QLF7TEGpaau9i0A9s3VjnegvtHde-SLRqI4suJFT4WI,3622
+pltr/commands/sql.py,sha256=wol0Rlvi_RplCFbOg4LCa3VXsOqmRZdFFVv7V6iVkh8,12602
+pltr/commands/verify.py,sha256=n8LWhbfGieYa-a5_l3MxqkYbdpyVf8-i0FQIL__AaPA,6650
+pltr/config/__init__.py,sha256=Y6gARy5lUHy-OJaOUxtfXoeQVNZV5QHLl6uKHQ8tpTk,41
+pltr/config/profiles.py,sha256=XMUIp6Ez5LNC6rGXZe2JLH7IKepXhARtuc8ASUA9FYA,3431
+pltr/config/settings.py,sha256=bfIiosPqH_W73TOHS71DvgZdAHka4fJDopU1SvBRFuQ,2908
+pltr/services/__init__.py,sha256=zQpgrqPdAkZI-nobi33mctU2-iGNgazzvjBVY8YRbSQ,101
+pltr/services/admin.py,sha256=8FjExmDeIKeVqkAxM83SVvpp_pH9W-Q33cgVs6BHxLQ,9957
+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/ontology.py,sha256=d5MD0QeLfqs6W_XdteiK1da0yo_TKSftBmEOfPiLvf8,14755
+pltr/services/sql.py,sha256=19cscjlzN8WE1s8_ctiRcrOvMzCfmWRj49vjJ8Gs5Q4,11286
+pltr/utils/__init__.py,sha256=DF7TigL1XbKVGM5VjgU8_8AGIszofkdO80oCzLGGnTE,38
+pltr/utils/completion.py,sha256=QdTkpT9MMs7C7keuJi79sMLerFX3CarpB4FrCKImjSc,4712
+pltr/utils/formatting.py,sha256=Ptv7obiB7uWNf5YTiY4rUAKmabO5UGnwLocSfLplrZ0,18552
+pltr/utils/progress.py,sha256=BKYbiLO61uhQbibabU7pxvvbAWMRLRmqk4pZldBQK_g,9053
+pltr_cli-0.2.0.dist-info/METADATA,sha256=xk4xxyxl6TXmvgvrcfkR91E-TgnJiA4FdDY6ElW434Y,8864
+pltr_cli-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pltr_cli-0.2.0.dist-info/entry_points.txt,sha256=8tvEcW04kA_oAE2Dwwu-Og9efjl4ESJvs4AzlP2KBdQ,38
+pltr_cli-0.2.0.dist-info/licenses/LICENSE,sha256=6VUFd_ytnOBD2O1tmkKrA-smigi9QEhYr_tge4h4z8Y,1070
+pltr_cli-0.2.0.dist-info/RECORD,,