Get Started with Keboola Component Development
This skill helps you initialize and set up new Keboola Python components from scratch using the official cookiecutter template.
When to Use This Skill
- •Starting a new Keboola component project
- •Need to understand the initialization process
- •Setting up the project structure correctly
- •Understanding cookiecutter template usage
Quick Start
The fastest way to start a new component:
bash
cookiecutter gh:keboola/cookiecutter-python-component
Then clean up and configure:
- •Remove cookiecutter example files from
data/directory - •Create component-specific
data/config.jsonwith example parameters - •Keep empty
data/folder structure (not committed to git)
Complete Initialization Guide
For detailed step-by-step instructions, see:
- •Initialization Guide - Complete setup process
What Happens During Initialization
The cookiecutter template creates:
- •
src/- Component Python code - •
component_config/- Configuration schemas and descriptions - •
tests/- Test structure - •
.github/workflows/- CI/CD pipelines - •
Dockerfile- Container definition - •
requirements.txt- Python dependencies - •
data/- Local testing directory (with examples to remove)
After Initialization
Once initialized, you'll typically want to:
- •Implement component logic (use
@build-componentskill) - •Design configuration schemas (use
@build-component-uiskill) - •Write tests (use
@test-componentskill) - •Deploy to Developer Portal
Key Resources
- •Cookiecutter Template: https://github.com/keboola/cookiecutter-python-component
- •Component Tutorial: https://developers.keboola.com/extend/component/tutorial/
- •Developer Docs: https://developers.keboola.com/
Next Steps
After getting started:
- •For component development: Use
@build-componentskill - •For UI/schema work: Use
@build-component-uiskill - •For testing: Use
@test-componentskill - •For debugging: Use
@debug-componentskill