tinybirdco Tinybird Python SDK Guidelines
Guidance for using the tinybird-sdk package to define Tinybird resources in Python.
When to Apply
- Installing or configuring tinybird-sdk
- Defining datasources, pipes, or endpoints in Python
- Creating Tinybird clients in Python
- Using data ingestion or queries in Python
- Running tinybird dev/build/deploy commands for Python projects
- Migrating from legacy .datasource/.pipe files to Python
- Defining connections (Kafka, S3, GCS)
- Creating materialized views, copy pipes, or sink pipes
Rule Files
rules/getting-started.mdrules/configuration.mdrules/defining-datasources.mdrules/defining-endpoints.mdrules/client.mdrules/low-level-api.mdrules/cli-commands.mdrules/connections.mdrules/materialized-views.mdrules/copy-sink-pipes.mdrules/tokens.md
Quick Reference
- Install:
pip install tinybird-sdk - Initialize:
tinybird init - Dev mode:
tinybird dev(uses configureddev_mode, typically branch) - Build:
tinybird build(builds against configured dev target) - Deploy:
tinybird deploy(deploys to main/production) - Preview in CI:
tinybird preview - Migrate:
tinybird migrate(convert .datasource/.pipe files to Python) - Server-side only; never expose tokens in browsers