Templates reference¶
Tycoon ships two featured built-in templates. Pick one with tycoon
init --template <name> or list them with tycoon init
--list-templates.
When to use which¶
| Template | What you get | Network needed | Best for |
|---|---|---|---|
csv-import |
CSV ingest + dbt + Rill | No | Smoke-testing the full pipeline offline |
nyc-transit |
Live NYC public-data feeds | Yes (no auth) | Demo / showing real ingestion |
csv-import¶
The fully-offline template. Ships with a working dbt project and a sample CSV so the full ingest → transform pipeline runs end-to-end on a fresh install.
tycoon init --template csv-import --name my-project
tycoon data sources run files
tycoon data transform run
What's in it¶
my-project/
├── tycoon.yml
├── data/input/widgets.csv # bundled sample data
├── dbt_project/
│ ├── dbt_project.yml
│ ├── profiles.yml
│ └── models/staging/
│ ├── stg_widgets.sql
│ └── schema.yml
└── rill/rill.yaml
Generated tycoon.yml¶
name: my-project
sources:
files:
type: filesystem
schema: raw_files
config:
bucket_url: data/input
file_glob: "*.csv"
Useful for¶
- First-time tycoon users who want to see the whole stack work without signing up for anything
- CI tests of any change touching ingestion / transformation /
observability — this template is the basis for the
offline_e2emarker that runs on every PR
nyc-transit¶
Live ingestion from NYC's open public-data APIs (Socrata-flavored REST). No authentication. No rate limits worth worrying about for demo-scale runs.
What's in it¶
Three pre-registered sources:
nyc-dot— NYC Department of Transportation traffic feeds (Socrata)mta-gtfs— MTA static GTFS feeds (subway / bus zip files)mta-bus-speeds— MTA bus segment speeds (Socrata)
Generated tycoon.yml¶
name: nyc-transit-demo
database:
raw: data/nyc_open_data_raw.duckdb
warehouse: data/nyc_open_data_local.duckdb
sources:
nyc-dot:
type: rest_api
schema: raw_nyc_dot
config:
base_url: https://data.cityofnewyork.us/resource/
datasets: [i4gi-tjb9, ycrg-ses3, 7ym2-wayt]
Useful for¶
- Showing the full live-ingestion path
- Time-series tables that play well with Rill dashboards
- Conference talks (the public-data part is the legible bit)
Adding your own template¶
Templates live under src/tycoon/templates/<name>/ in the tycoon
source repo. Each contains:
templates/my-template/
├── tycoon.yml # source template, with {{ var }} placeholders
├── template.yml # optional — declares parameters
└── (any other files to copy verbatim into a new project)
template.yml (optional) declares parameters:
tycoon init --template my-template substitutes {{ owner }} /
{{ repo }} placeholders in any .yml, .yaml, .sql, .md, or
.txt file at scaffold time. The template.yml itself isn't copied
into the target project (it's build-time metadata only).
For now, custom templates require a tycoon source checkout — there's no
~/.tycoon/templates/ discovery path yet. Tracked as a follow-up.