mcpField
T
tinybird-python-sdk-guidelines

tinybird-python-sdk-guidelines

github.com/tinybirdcoData & databases22621 installsUpdated 13w ago
Repository

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

  1. 01Python datasource and pipe definitions
  2. 02Endpoint and client setup
  3. 03Ingestion and query guidance
  4. 04Connection and materialized view guidance
  5. 05CLI workflows and legacy migration

Use cases

  1. 01Defining Tinybird resources in a Python project
  2. 02Running development, build, and deployment commands
  3. 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-guidelines

After 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.md
client.md
configuration.md
connections.md
copy-sink-pipes.md
defining-datasources.md
defining-endpoints.md
getting-started.md
low-level-api.md
materialized-views.md
tokens.md

Details

From the project README

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.md
  • rules/configuration.md
  • rules/defining-datasources.md
  • rules/defining-endpoints.md
  • rules/client.md
  • rules/low-level-api.md
  • rules/cli-commands.md
  • rules/connections.md
  • rules/materialized-views.md
  • rules/copy-sink-pipes.md
  • rules/tokens.md

Quick Reference

  • Install: pip install tinybird-sdk
  • Initialize: tinybird init
  • Dev mode: tinybird dev (uses configured dev_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