Prerequisites
- Python 3.8+ - The SDK requires Python 3.8 or higher
- API Key - Get your API key from the Kubiya platform
- Organization ID - Your organization identifier from Kubiya
Installation
Install via pip
Install from source
Install with optional dependencies
Configuration
Environment Variables
Set up your credentials using environment variables:Configuration File
Create a configuration file at~/.kubiya/config.yaml
:
Programmatic Configuration
Verify Installation
Quick Test
Version Check
Feature Test
IDE Setup
VS Code
Install the Python extension and add these settings to your workspace:PyCharm
- Go to File > Settings > Project > Python Interpreter
- Add the kubiya-sdk package to your interpreter
- Enable type checking in Settings > Editor > Inspections > Python
Development Setup
Clone Repository
Create Virtual Environment
Install Development Dependencies
Run Tests
Docker Setup
Using Docker
Docker Compose
Troubleshooting
Common Issues
Import Error
Authentication Error
Connection Timeout
SSL Certificate Error
Debug Mode
Enable debug logging to troubleshoot issues:Version Compatibility
Kubiya SDK | Python | Kubiya Platform |
---|---|---|
1.0.x | 3.8+ | v2.0+ |
0.9.x | 3.7+ | v1.5+ |