Install ResinKit SDK
Prerequisites
- Python 3.9+
- JupyterLab/Notebook
- Optional: Panel for UI widgets (
panel)
Install
From source:git clone https://github.com/resink-ai/resinkit-sdk-python
cd resinkit-sdk-python
uv sync --dev
pip install resinkit-sdk-python
Verify installation:python -c "import resinkit; print('resinkit', resinkit.__version__)"
Connect to resink.ai
resink.ai cloud
Local instance
from resinkit import Resinkit
rs = Resinkit()
rs.ui_flink_sql().show()
from resinkit import Resinkit
rs = Resinkit(
resinkit_session="<your_resinkit_session>",
personal_access_token="<your_personal_access_token>",
sql_gateway_url="<your_sql_gateway_url>",
base_url="<your_resinkit_service_url>/api",
)
rs.ui_flink_sql().show()
Never commit tokens or secrets.
Quick UI checks:rs.ui_flink_sql().show()
rs.ui_vars().show()
rs.ui_sources().show()
First steps in the UI
Variables UI
Create/list/delete variables with secure value fetch.
Data Sources UI
Add SQL/Kafka sources and test connections; crawl schemas.
Flink SQL UI
Submit streaming SQL and view live tabular results.
Build a basic RTDW
Follow these recommended workflows to stand up a production-ready RTDW:
S001: Entity Extraction & Archiving
Extract entities and store history for enrichment.
S002: Raw Event Ingestion & Storage
Land and retain raw events efficiently.
S005: Aggregation (Session/Daily)
Build session windows and daily aggregates.
S008: SCD Type 2
Maintain entity history for point-in-time analytics.
S011: CDC to Iceberg
Stream database changes into Iceberg.
Start simple with daily snapshots. Add SCD Type 2 where precise history is
required.
Learn the basics
RTDW Basics
Understand events, entities, and aggregation design.
