Back to Details

tinybird-python-sdk-guidelines

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Tinybird Python SDK Guidelines

Tinybird Python SDK 使用指南

Guidance for using the

tinybird-sdk

package to define Tinybird resources in Python.

本指南介绍如何使用

tinybird-sdk

包在Python中定义Tinybird资源。

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

安装或配置tinybird-sdk
在Python中定义数据源、管道或端点
在Python中创建Tinybird客户端
在Python中使用数据摄入或查询功能
为Python项目运行tinybird dev/build/deploy命令
从传统的.datasource/.pipe文件迁移到Python
定义连接（Kafka、S3、GCS）
创建物化视图、复制管道或输出管道

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
```

```
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

安装：
```
pip install tinybird-sdk
```
初始化：
```
tinybird init
```
开发模式：
```
tinybird dev
```
（使用配置的
```
dev_mode
```
，通常为分支）
构建：
```
tinybird build
```
（针对配置的开发目标构建）
部署：
```
tinybird deploy
```
（部署到主环境/生产环境）
CI中预览：
```
tinybird preview
```
迁移：
```
tinybird migrate
```
（将.datasource/.pipe文件转换为Python格式）
仅支持服务端使用；切勿在浏览器中暴露令牌