Skip to content

Commit 3780b80

Browse files
docs: rename from workshop to sandbox terminology
Update project terminology to better reflect its purpose as a sandbox environment for exploring transit operational data transformation patterns. - Rename database file from workshop.duckdb to sandbox.duckdb - Update README with new introduction describing the project context - Add link to TIDES specification and mention Common Transit Operations Data Framework - Update all references in CI, scripts, and documentation Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent fc1c2f5 commit 3780b80

File tree

6 files changed

+17
-15
lines changed

6 files changed

+17
-15
lines changed

.github/workflows/ci.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ jobs:
6868

6969
- name: Verify database was created
7070
run: |
71-
if [ ! -f workshop.duckdb ]; then
72-
echo "Error: workshop.duckdb was not created"
71+
if [ ! -f sandbox.duckdb ]; then
72+
echo "Error: sandbox.duckdb was not created"
7373
exit 1
7474
fi
75-
echo "workshop.duckdb exists ($(stat -c%s workshop.duckdb) bytes)"
75+
echo "sandbox.duckdb exists ($(stat -c%s sandbox.duckdb) bytes)"

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# GTFS-RT DuckDB Workshop
1+
# GTFS-RT Sandbox
22

3-
Query real-time transit data using DuckDB and dbt.
3+
A sandbox environment for exploring transit operational data transformation patterns using DuckDB and dbt. Part of the **Common Transit Operations Data Framework**, this demo shows how raw operational data can be transformed into [TIDES](https://tides-transit.org/)-compliant analytics tables using architectural patterns that scale from a laptop to enterprise cloud infrastructure.
4+
5+
This sandbox uses publicly available GTFS-RT feeds as source data. In production, you would typically use raw AVL system exports which contain richer data, but GTFS-RT provides an accessible starting point for learning the patterns.
46

57
## Quick Start
68

@@ -17,7 +19,7 @@ Query real-time transit data using DuckDB and dbt.
1719
4. Query your data:
1820

1921
```bash
20-
duckdb workshop.duckdb -ui
22+
duckdb sandbox.duckdb -ui
2123
```
2224

2325
### Option 2: Local Setup
@@ -42,14 +44,14 @@ uv run python scripts/download_data.py --defaults
4244
uv run dbt run
4345

4446
# Query the data
45-
duckdb workshop.duckdb -ui
47+
duckdb sandbox.duckdb -ui
4648
```
4749

4850
> **Note:** If you get a "Failed to download extension" error with `-ui`, see [DuckDB UI Extension Error](docs/troubleshooting.md#duckdb-ui-extension-error).
4951
5052
## How It Works
5153

52-
This workshop uses a two-phase approach:
54+
This sandbox uses a two-phase approach:
5355

5456
1. **Download data** (`download_data.py`) - fetches parquet files to `data/`
5557
2. **Transform data** (`dbt run`) - creates views in DuckDB reading from local files
@@ -113,7 +115,7 @@ uv run dbt run --select stg_vehicle_positions
113115
uv run dbt docs generate && uv run dbt docs serve
114116

115117
# Query the database
116-
duckdb workshop.duckdb -ui
118+
duckdb sandbox.duckdb -ui
117119
```
118120

119121
## Data Schema
@@ -158,8 +160,8 @@ duckdb workshop.duckdb -ui
158160

159161
## Need Help?
160162

161-
See [docs/troubleshooting.md](docs/troubleshooting.md) for common issues and solutions.
163+
See [docs/troubleshooting.md](docs/troubleshooting.md) for common issues and solutions, or [open an issue](https://github.com/JarvusInnovations/gtfsrt-sandbox/issues) if you're stuck.
162164

163165
## License
164166

165-
Data sourced from public GTFS-RT feeds. Workshop materials are MIT licensed.
167+
Data sourced from public GTFS-RT feeds. Sandbox materials are MIT licensed.

docs/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ INSTALL ui FROM core_nightly;
8181
.quit
8282
```
8383

84-
Now `duckdb workshop.duckdb -ui` should work.
84+
Now `duckdb sandbox.duckdb -ui` should work.
8585

8686
## Getting Help
8787

profiles.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ gtfsrt_sandbox:
33
outputs:
44
dev:
55
type: duckdb
6-
path: workshop.duckdb
6+
path: sandbox.duckdb
77
extensions:
88
- parquet
99
settings:

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[project]
22
name = "gtfsrt-sandbox"
33
version = "0.1.0"
4-
description = "DuckDB + dbt workshop for querying GTFS-RT parquet data"
4+
description = "DuckDB + dbt sandbox for exploring GTFS-RT data transformation patterns"
55
readme = "README.md"
66
requires-python = ">=3.12"
77
dependencies = [

scripts/download_data.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ def print_summary(results: dict[str, tuple[int, int]], output_dir: Path) -> None
225225
print(f"\nData saved to: {output_dir}/")
226226
print("\nNext steps:")
227227
print(" uv run dbt run # Transform the data")
228-
print(" duckdb workshop.duckdb -ui # Query the results")
228+
print(" duckdb sandbox.duckdb -ui # Query the results")
229229

230230

231231
def main():

0 commit comments

Comments
 (0)