How keboola/python-component works
Main Components and Layers
a) Core Library Layer (Center):
• Interface Module (Blue)
• DAO Module (Green)
• Base Module (Orange)
b) Infrastructure Layer (Bottom):
• Keboola Common Interface
• Docker Environment
• File System (Data Directory)
c) Integration Layer (Top):
• Component Implementation
• Python Transformations
• Keboola Connection
Component Relationships
a) Core Components:
CommonInterface
• Configuration Management
• Environment Variables
• Data Folder Management
• Manifest Processing
• Logging System
b) Data Access Objects:
DAO
• TableDefinition
• FileDefinition
• TableMetadata
• ColumnDefinition
c) Base Components:
ComponentBase
• Sync Actions
• Configuration Validation
• Execution Flow
Specific Elements
a) Input/Output Processing:
• Input Tables/Files Processing
• Output Tables/Files Generation
• Manifest File Handling
• State File Management
b) Configuration Flow:
• Environment Variables
• Config.json Processing
• Parameter Validation
c) Execution Flow:
• Sync Actions Processing
• Error Handling
• Logging System
Additional Details
• Component types
• Special symbols
Annotations for:
• Required environment variables
• Critical file paths
• Important configuration parameters
Implementation Notes
• The library's role as a wrapper/abstraction layer
• The separation of concerns between interface, data objects, and base components
• The automated handling of common tasks (logging, configuration, validation)
• The extensibility points for custom components
Key Interactions to Highlight
• Component initialization flow
• Configuration validation process
• Table/File manifest processing
• Sync action execution flow
• Error handling and logging paths
Remember to include version information and any critical dependencies, as this will help developers understand the complete ecosystem of the component library.