T
tinybird-python-sdk-guidelines
About tinybird-python-sdk-guidelines
Guidance for using `tinybird-sdk` to define and manage Tinybird resources in Python. It covers data resources, clients, ingestion and queries, connections, deployment commands, and migration from legacy files.
Key features
- 01Python datasource and pipe definitions
- 02Endpoint and client setup
- 03Ingestion and query guidance
- 04Connection and materialized view guidance
- 05CLI workflows and legacy migration
Use cases
- 01Defining Tinybird resources in a Python project
- 02Running development, build, and deployment commands
- 03Migrating `.datasource` and `.pipe` files to Python
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ tinybirdco/ tinybird-agent-skills --skill tinybird-python-sdk-guidelinesAfter installing, type/tinybird-python-sdk-guidelinesin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
rules/cli-commands.mdclient.mdconfiguration.mdconnections.mdcopy-sink-pipes.mddefining-datasources.mddefining-endpoints.mdgetting-started.mdlow-level-api.mdmaterialized-views.mdtokens.mdDetails
From the project READMETinybird 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
Comments
Markdown supported