get-started_skill

Overview

This skill guides you through initializing and setting up a new Keboola Python component using the official cookiecutter template. It provides practical steps to create the project structure, clean sample files, and configure local testing data. Use it to get a working scaffold quickly and consistently for component development.

How this skill works

The skill walks you through running the cookiecutter generator and explains what files and folders the template creates (src, component_config, tests, CI workflows, Dockerfile, requirements, data). It describes the minimal cleanup and configuration tasks to make the scaffold ready for development and local testing. It also points to next steps for implementing logic, schemas, tests, and deployment.

When to use it

• Starting a new Keboola Python component project from scratch
• You need a standard, repeatable project scaffold and CI setup
• Preparing a local testing data directory and initial config.json
• Onboarding team members to component structure and conventions
• Before implementing component logic, UI schema, or automated tests

Best practices

• Run cookiecutter and immediately remove example files from the data/ directory
• Create a component-specific data/config.json with example parameters for local testing
• Keep an empty data/ folder structure in source control, but avoid committing example data
• Define configuration schemas early in component_config/ to drive UI and validation
• Add tests under tests/ and wire them into CI in .github/workflows/

Example use cases

• Quickly scaffold a Keboola Python component to implement new integration logic
• Set up a reproducible template for multiple team members to begin development
• Prepare a component repo ready for schema-driven UI development and testing
• Bootstrap a component when contributing an integration to Keboola Developer Portal
• Create a local development environment with a sample config.json for manual runs