How scalefreecom/turbovault-engine works
TurboVault Engine turns source metadata into Data Vault models and then generates dbt projects or exports the model in other formats. The principal path runs from CLI or web project setup through metadata import and model management, into export-model construction, validation/planning/rendering, and artifact writing. The README also documents admin-based model editing, configurable templates, and JSON, DBML, and IRiS exports. Some import and generation stage links are documented rather than shown in sampled source; those edges cite the README or are marked unverified.
Main entry points: main.py CLI commands · pipeline.py Generation pipeline · executor.py Import executor · imports Metadata import
Components 22
User interfaces
- CLI commands
backend/engine/cli/main.py - Web initializer
backend/turbovault/views.py - Django Admin
backend/engine/admin.py
Metadata and modeling
- Project setup
backend/engine/models/project.py - Metadata import
backend/engine/services/imports - Format parsers
backend/engine/services/imports/parsers - Import executor
backend/engine/services/imports/executor.py - Source metadata
backend/engine/models/source_metadata.py - Data Vault model
backend/engine/models - Staging mappings
backend/engine/models/staging.py
Generation and export
- Export model builder
backend/engine/services/export/builder.py - Intermediate export model
backend/engine/services/export/models.py - Generation pipeline
backend/engine/services/generation/pipeline.py - Model validation
backend/engine/services/generation/stages/validate.py - Output planning
backend/engine/services/generation/stages/plan.py - Rendering and exports
backend/engine/services/generation/stages/render.py - dbt project generator
backend/engine/services/generation/generator.py - Generated artifacts
backend/engine/services/generation/stages/write.py - JSON, DBML, IRiS
backend/engine/services/export/exporters
Configuration
- Runtime configuration
backend/engine/services/runtime_config.py - Generation templates
backend/engine/models/templates.py
Other components
- Engineer
Connections 28
- Engineer → CLI commands: runs commands
README.md - Engineer → Web initializer: uses wizard
README.md - Engineer → Django Admin: manages models
README.md - CLI commands → Project setup: creates projects
- Web initializer → Project setup: creates project
backend/turbovault/views.py - Web initializer → Metadata import: imports metadata
backend/turbovault/views.py - CLI commands → Metadata import: imports metadata
- Metadata import → Format parsers: selects format parser
backend/engine/services/imports/validation/resolver.py - Metadata import → Import executor: executes import
backend/engine/services/imports/executor.py - Import executor → Data Vault model: writes entities
backend/engine/services/imports/executor.py - Import executor → Source metadata: resolves source data
backend/engine/services/imports/executor.py - Import executor → Staging mappings: creates mappings
- Django Admin → Data Vault model: edits model
README.md - CLI commands → Data Vault model: manages entities
- Data Vault model → Export model builder: builds export from
backend/engine/services/export/builder.py - Runtime configuration → Export model builder: configures build
backend/engine/services/export/builder.py - Export model builder → Intermediate export model: produces
backend/engine/services/export/builder.py - CLI commands → Generation pipeline: requests generation
- Generation pipeline → Export model builder: builds export
backend/engine/services/generation/pipeline.py - Generation pipeline → Model validation: validates model
backend/engine/services/generation/pipeline.py - Generation pipeline → Output planning: builds plan
backend/engine/services/generation/pipeline.py - Generation pipeline → Rendering and exports: renders output
backend/engine/services/generation/pipeline.py - Generation pipeline → Generated artifacts: writes output
backend/engine/services/generation/pipeline.py - Rendering and exports → dbt project generator: renders dbt
backend/engine/services/generation/stages/render.py - dbt project generator → Generation templates: resolves templates
backend/engine/services/generation/generator.py - Rendering and exports → JSON, DBML, IRiS: renders formats
backend/engine/services/generation/stages/render.py - CLI commands → JSON, DBML, IRiS: exports model
- Project setup → Runtime configuration: provides defaults
backend/engine/services/runtime_config.py