model2data 0.4.3__tar.gz → 1.0.0__tar.gz

model2data-1.0.0/PKG-INFO

@@ -0,0 +1,312 @@
+Metadata-Version: 2.4
+Name: model2data
+Version: 1.0.0
+Summary: Generate analytics-ready datasets from DBML models
+Author: JB Analytica
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/JB-Analytica/model2data
+Project-URL: Repository, https://github.com/JB-Analytica/model2data
+Project-URL: Issues, https://github.com/JB-Analytica/model2data/issues
+Project-URL: Changelog, https://github.com/JB-Analytica/model2data/blob/main/CHANGELOG.md
+Keywords: dbt,dbml,synthetic-data,test-data,analytics-engineering,data-engineering,duckdb,seed-data
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dbt-core>=1.11
+Requires-Dist: dbt-duckdb>=1.11
+Requires-Dist: faker>=37.12.0
+Requires-Dist: pandas>=2.3.3
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: typer>=0.20.0
+Provides-Extra: postgres
+Requires-Dist: dbt-postgres>=1.11; extra == "postgres"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: ty>=0.0.4; extra == "dev"
+Requires-Dist: types-pyyaml; extra == "dev"
+Requires-Dist: poethepoet>=0.38.0; extra == "dev"
+Dynamic: license-file
+
+# model2data
+
+[![PyPI](https://img.shields.io/pypi/v/model2data)](https://pypi.org/project/model2data/)
+[![CI](https://github.com/JB-Analytica/model2data/actions/workflows/ci.yml/badge.svg)](https://github.com/JB-Analytica/model2data/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/JB-Analytica/model2data/branch/main/graph/badge.svg)](https://codecov.io/gh/JB-Analytica/model2data)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/JB-Analytica/model2data/blob/main/LICENSE)
+
+**Turn a data model into a running analytics stack in one command.**
+
+Give `model2data` a [DBML](https://dbml.dbdiagram.io/docs/) schema — hand-written or exported
+from an existing database — and it generates realistic, relationship-preserving synthetic data
+*and* a complete, runnable dbt project around it: seeds, staging models, tests, and a
+DuckDB or Postgres profile. No sample data to hunt down, no dbt boilerplate to hand-write, no
+production data to risk exposing.
+
+```bash
+pip install model2data
+model2data --file examples/ecommerce.dbml --rows 200 --seed 42
+cd dbt_ecommerce && dbt build
+```
+
+That's a working analytics stack — real (synthetic) data, tested dbt models, queryable in
+DuckDB — from a schema file, in seconds:
+
+![model2data generating a project and running it with dbt](https://raw.githubusercontent.com/JB-Analytica/model2data/main/assets/demo.gif)
+
+---
+
+## Why this exists
+
+Analytics engineers hit the same wall constantly: you need realistic data to build or test a
+pipeline, but production data is off-limits (privacy, access, scale), and hand-rolling mock CSVs
+is tedious and doesn't scale past two tables. `model2data` closes that gap — from a schema
+definition to a seeded, tested dbt project you can actually run, with no database or production
+access required.
+
+- **Privacy-safe.** Nothing but a schema definition goes in; nothing but synthetic data comes out.
+- **Realistic, not random.** Column names are matched against ~35 common patterns — `email`,
+  `first_name`, `city`, `phone`, `company`, ... — so a column called `email` gets real-looking
+  emails, not `Lorem ipsum` text.
+- **Relationship-preserving.** Foreign keys resolve to real parent rows; tables are generated in
+  dependency order.
+- **Deterministic.** Pass `--seed` and the same schema always produces the same data — safe to
+  commit fixtures, safe to diff across CI runs.
+- **A real dbt project, not just CSVs.** Seeds, staging models that `ref()` them, schema tests,
+  and a ready-to-use profile — the thing you'd otherwise spend an afternoon scaffolding by hand.
+  A single `dbt build` loads, transforms, and tests the whole thing.
+
+## Who is model2data for?
+
+- **Analytics engineers** — generate realistic datasets and a working dbt project without
+  waiting on production access.
+- **Data engineers** — produce deterministic test data from an existing schema for pipeline and
+  migration testing.
+- **Software & data teams** — prototype integrations and analytics workflows without exposing
+  production data.
+- **Consultants & architects** — spin up realistic environments for demos, workshops, and
+  architecture validation in minutes, not hours.
+
+## How it works
+
+1. **Parse.** Reads tables, columns, types, and `Ref` relationships from a DBML file.
+2. **Generate.** Produces synthetic values per column — typed generation for known SQL types
+   (int, date, timestamp, ...), name-aware inference for everything else (`email`, `phone`,
+   `city`, ...), foreign keys resolved against already-generated parent rows.
+3. **Scaffold.** Writes a complete dbt project around that data: CSV seeds, staging models that
+   `ref()` those seeds, `not_null`/`unique`/`relationships` tests, `accepted_values` tests for
+   DBML `Enum`-typed columns, singular SQL tests for composite primary/unique keys, table and
+   column `description:` fields pulled from DBML notes, and a profile for DuckDB (zero-config,
+   file-based) or Postgres.
+
+---
+
+## Installation
+
+```bash
+pip install model2data
+```
+
+---
+
+## Quick start
+
+We bundle several example schemas in `examples/` — this walkthrough uses the e-commerce one
+(`examples/ecommerce.dbml`: customers, products, orders, order items, and reviews).
+
+Generate a project with synthetic data:
+
+```bash
+model2data --file examples/ecommerce.dbml --rows 200 --seed 42
+```
+
+This creates a `dbt_ecommerce/` folder with your data and dbt setup.
+
+Run dbt to load, transform, and test the data:
+
+```bash
+cd dbt_ecommerce
+dbt build
+```
+
+Staging models `ref()` their seeds, so a single `dbt build` loads the seeds, builds the models,
+and runs every generated test in one dependency-ordered pass — no separate `dbt seed`/`dbt run`
+needed, even on a brand-new database. (The individual `dbt deps`, `dbt seed`, and `dbt run`
+commands still work if you'd rather drive the steps yourself; the generated project declares no
+packages, so `dbt deps` is a no-op.)
+
+Your analytics-ready dataset is now in DuckDB!
+
+To target Postgres instead, install the extra and pass `--adapter postgres`:
+
+```bash
+pip install "model2data[postgres]"
+model2data --file examples/ecommerce.dbml --rows 200 --seed 42 --adapter postgres
+```
+
+Connection details are read from environment variables (`MODEL2DATA_PG_HOST`, `MODEL2DATA_PG_PORT`, `MODEL2DATA_PG_USER`, `MODEL2DATA_PG_PASSWORD`, `MODEL2DATA_PG_DATABASE`), defaulting to `localhost:5432` with a `postgres`/`postgres` user for local development.
+
+After generation, the CLI prints a short summary — tables and rows generated, relationships found in the DBML, and any columns that fell back to generic placeholder text because neither their type nor name could be matched.
+
+Pass `--unit-tests` to also generate deterministic dbt unit test fixtures (`models/staging/ut_stg_<table>.yml`) from the actually-generated seed rows:
+
+```bash
+model2data --file examples/ecommerce.dbml --rows 200 --seed 42 --unit-tests
+```
+
+This targets dbt-core's native unit testing feature, which works out of the box with the base
+install — see [dbt-core versions](#dbt-core-versions) below.
+
+---
+
+## Generated dbt project structure
+
+The generated dbt project includes:
+
+```
+dbt_{project_name}/
+├── seeds/
+│   └── raw/
+│       ├── __seed_config.yml  # seed descriptions + column-type overrides
+│       ├── table1.csv
+│       └── table2.csv
+├── models/
+│   └── staging/
+│       ├── stg_table1.sql
+│       ├── stg_table1.yml
+│       ├── ut_stg_table1.yml  # only with --unit-tests
+│       └── ...
+├── data-tests/
+│   └── unique_combination_stg_table1_col_a_col_b.sql  # only for composite pk/unique keys
+├── macros/
+│   └── generate_schema_name.sql
+├── dbt_project.yml
+├── profiles.yml  # DuckDB or Postgres config, depending on --adapter
+└── {project_name}_profile.duckdb  # DuckDB adapter only
+```
+
+- **Seeds**: CSV files with generated synthetic data, plus `__seed_config.yml` — each seed's
+  `description:` (from the table's DBML `Note`) and the column-type overrides that keep
+  all-digit text columns (barcodes, zero-padded postcodes, ...) from being loaded as integers.
+- **Staging Models**: Basic dbt models that `ref()` their seed. Using `ref()` rather than
+  declaring the seeds as dbt `sources` is what gives each model a real DAG edge to the seed
+  behind it, so one `dbt build` orders seeds before models on a fresh database.
+- **Tests**: A YAML per staging model with column tests (`not_null`, `unique`, `relationships`,
+  and `accepted_values` for DBML `Enum`-typed columns). Column `Note` text from the DBML becomes
+  `description:` fields.
+- **Composite key tests**: Composite primary/unique keys declared in an `indexes { }` block get
+  a singular SQL test under `data-tests/`, dbt's configured `test-paths`.
+- **Profiles**: Pre-configured for DuckDB (file-based) or Postgres (via env vars), with schema handling.
+- **Unit tests** (opt-in via `--unit-tests`): `models/staging/ut_stg_<table>.yml` fixtures built
+  from real generated rows, co-located with each staging model so dbt (which only parses unit
+  tests from `model-paths`) picks them up.
+
+---
+
+## Using model2data with an LLM
+
+If you want to go from a plain-English description of a data model straight to a running,
+demo-ready dbt project, [LLMS.md](https://github.com/JB-Analytica/model2data/blob/main/LLMS.md) is written for an LLM/agent to read: it covers the
+full DBML feature set model2data understands (enums, notes, defaults, composite keys, both
+relationship syntaxes, self-references) and the exact command sequence to run. Point an
+LLM-backed coding assistant at it and describe your data model — it can author the DBML and run
+model2data for you.
+
+---
+
+## dbt-core versions
+
+model2data requires **dbt-core >= 1.11**, tracking [dbt's own version support
+policy](https://docs.getdbt.com/docs/dbt-versions): dbt Labs supports each minor release for one
+year, and 1.11 is the oldest that still is. Generated projects build cleanly — no deprecation
+warnings — on every supported dbt-core version, and CI proves it on each push by running a real
+`dbt build` against both the stated floor and the newest release.
+
+If you're pinned to an older dbt-core, use model2data 0.5.x, which supported down to 1.8.5.
+
+---
+
+## Design decisions / non-goals
+
+- **DuckDB Default**: Chosen for its zero-config, file-based nature, making it easy to get started without database setup. Postgres is supported via `--adapter postgres`; other adapters can be configured manually.
+- **dbt Integration**: Leverages dbt's transformation capabilities for a familiar workflow in analytics engineering.
+- **Synthetic Data**: Uses deterministic generation for reproducibility; not intended for production use or as a replacement for real data.
+- **Non-goals**: This is not a data migration tool, ETL pipeline, or real-time data generator. It focuses on static, synthetic datasets for testing and prototyping.
+
+---
+
+## Limitations
+
+- Synthetic data generation is heuristic-based (typed generation, name-aware inference, enum/default awareness) and may not perfectly mimic real-world distributions or edge cases.
+- DuckDB and Postgres are supported today; other databases require manual profile adjustments.
+- No support for incremental models or advanced dbt features in generated projects.
+- Composite foreign keys (across a bridge/join table) are generated as independent single-column FKs — each column's values are individually valid, but the *combination* isn't guaranteed to match a real parent composite key unless that key is separately enforced via `indexes { }`.
+- Any DBML the parser can't fully make sense of (a malformed line, a ref pointing at an unknown table, an unrecognized column definition) is reported as a warning in the CLI's summary rather than silently dropped — check that summary after generating from a schema you didn't author yourself.
+
+---
+
+## Project status
+
+As of `1.0.0`, model2data is considered **feature-complete for its intended use case**: turning a
+DBML schema into realistic synthetic data and a runnable dbt project, reliably. There's no active
+roadmap of new capabilities planned — the focus from here is maintenance: bug fixes, keeping pace
+with new dbt-core releases, and reviewing community contributions.
+
+Ideas that came up during development but were deliberately left out of scope, in case anyone
+wants to pick them up as a contribution:
+
+- Additional database adapters (e.g. Snowflake, BigQuery).
+- A rule-based semantic layer scaffold (`semantic_models.yml`/basic metrics) derived from the
+  parsed schema shape.
+- Example mart-layer models on top of staging (the generated `dbt_project.yml` carries a
+  ready-to-uncomment `marts` schema/materialization config for this).
+- Locale-aware generation (`--locale`) for non-English/US synthetic data.
+
+See [CONTRIBUTING.md](https://github.com/JB-Analytica/model2data/blob/main/CONTRIBUTING.md) if you'd like to work on any of these.
+
+---
+
+## Contributing
+
+We welcome contributions!
+
+- Open issues for bugs or feature requests.
+- Submit PRs to add new DBML examples, custom data generators, or improvements.
+- Ensure all new features include tests if possible.
+
+See [CONTRIBUTING.md](https://github.com/JB-Analytica/model2data/blob/main/CONTRIBUTING.md) for detailed guidelines, and [DEVELOPMENT.md](https://github.com/JB-Analytica/model2data/blob/main/DEVELOPMENT.md) for the local dev setup and release process.
+
+## Code of Conduct
+
+Please read our [Code of Conduct](https://github.com/JB-Analytica/model2data/blob/main/CODE_OF_CONDUCT.md) to understand our community standards.
+
+---
+
+## License
+
+MIT License. See LICENSE for details.
+
+---
+
+<p align="center">
+  <a href="https://www.jbanalytica.com">
+    <img src="https://raw.githubusercontent.com/JB-Analytica/model2data/main/assets/jba-icon-dark-bg.svg" alt="JB Analytica" height="40">
+  </a>
+  <br>
+  Built and maintained by <a href="https://www.jbanalytica.com"><strong>JB Analytica</strong></a> —
+  Data & Analytics Engineering · Data Platform Architecture · Modern BI.
+</p>

model2data-0.4.3/PKG-INFO → model2data-1.0.0/README.md

@@ -1,28 +1,3 @@
-Metadata-Version: 2.4
-Name: model2data
-Version: 0.4.3
-Summary: Generate analytics-ready datasets from DBML models
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: dbt-core>=1.5.0
-Requires-Dist: dbt-duckdb>=1.5.0
-Requires-Dist: faker>=37.12.0
-Requires-Dist: pandas>=2.3.3
-Requires-Dist: pyyaml>=6.0.3
-Requires-Dist: typer>=0.20.0
-Provides-Extra: postgres
-Requires-Dist: dbt-postgres>=1.5.0; extra == "postgres"
-Provides-Extra: dev
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: ruff>=0.1.0; extra == "dev"
-Requires-Dist: ty>=0.0.4; extra == "dev"
-Requires-Dist: types-pyyaml; extra == "dev"
-Requires-Dist: poethepoet>=0.38.0; extra == "dev"
-Dynamic: license-file
-
 # model2data
 
 [![PyPI](https://img.shields.io/pypi/v/model2data)](https://pypi.org/project/model2data/)
@@ -34,20 +9,20 @@ Dynamic: license-file
 
 Give `model2data` a [DBML](https://dbml.dbdiagram.io/docs/) schema — hand-written or exported
 from an existing database — and it generates realistic, relationship-preserving synthetic data
-*and* a complete, runnable dbt project around it: seeds, staging models, sources, tests, and a
+*and* a complete, runnable dbt project around it: seeds, staging models, tests, and a
 DuckDB or Postgres profile. No sample data to hunt down, no dbt boilerplate to hand-write, no
 production data to risk exposing.
 
 ```bash
 pip install model2data
-model2data --file examples/hackernews.dbml --rows 200 --seed 42
-cd dbt_hackernews && dbt seed && dbt run
+model2data --file examples/ecommerce.dbml --rows 200 --seed 42
+cd dbt_ecommerce && dbt build
 ```
 
 That's a working analytics stack — real (synthetic) data, tested dbt models, queryable in
 DuckDB — from a schema file, in seconds:
 
-![model2data generating a project and running it with dbt](assets/demo.gif)
+![model2data generating a project and running it with dbt](https://raw.githubusercontent.com/JB-Analytica/model2data/main/assets/demo.gif)
 
 ---
 
@@ -67,8 +42,9 @@ access required.
   dependency order.
 - **Deterministic.** Pass `--seed` and the same schema always produces the same data — safe to
   commit fixtures, safe to diff across CI runs.
-- **A real dbt project, not just CSVs.** Seeds, staging models, sources, schema tests, and a
-  ready-to-use profile — the thing you'd otherwise spend an afternoon scaffolding by hand.
+- **A real dbt project, not just CSVs.** Seeds, staging models that `ref()` them, schema tests,
+  and a ready-to-use profile — the thing you'd otherwise spend an afternoon scaffolding by hand.
+  A single `dbt build` loads, transforms, and tests the whole thing.
 
 ## Who is model2data for?
 
@@ -106,7 +82,7 @@ flowchart LR
     D --> E
     D --> F
     D --> G
-    E & F & G --> H["dbt seed && dbt run"]
+    E & F & G --> H["dbt build"]
     H --> I[("Analytics-ready\ndataset")]
 
     classDef m2dStyle fill:#0A3866,stroke:#2196F0,color:#F6F8FB
@@ -121,10 +97,10 @@ flowchart LR
 2. **Generate.** Produces synthetic values per column — typed generation for known SQL types
    (int, date, timestamp, ...), name-aware inference for everything else (`email`, `phone`,
    `city`, ...), foreign keys resolved against already-generated parent rows.
-3. **Scaffold.** Writes a complete dbt project around that data: CSV seeds, staging models with
-   `source`/`not_null`/`unique`/`relationships` tests, `accepted_values` tests for DBML
-   `Enum`-typed columns, singular SQL tests for composite primary/unique keys, table and column
-   `description:` fields pulled from DBML notes, and a profile for DuckDB (zero-config,
+3. **Scaffold.** Writes a complete dbt project around that data: CSV seeds, staging models that
+   `ref()` those seeds, `not_null`/`unique`/`relationships` tests, `accepted_values` tests for
+   DBML `Enum`-typed columns, singular SQL tests for composite primary/unique keys, table and
+   column `description:` fields pulled from DBML notes, and a profile for DuckDB (zero-config,
    file-based) or Postgres.
 
 ---
@@ -139,32 +115,37 @@ pip install model2data
 
 ## Quick start
 
-We provide an example Hacker News dataset in `examples/hackernews.dbml`.
+We bundle several example schemas in `examples/` — this walkthrough uses the e-commerce one
+(`examples/ecommerce.dbml`: customers, products, orders, order items, and reviews).
 
 Generate a project with synthetic data:
 
 ```bash
-model2data --file examples/hackernews.dbml --rows 200 --seed 42
+model2data --file examples/ecommerce.dbml --rows 200 --seed 42
 ```
 
-This creates a `dbt_hackernews/` folder with your data and dbt setup.
+This creates a `dbt_ecommerce/` folder with your data and dbt setup.
 
-Run dbt to load and transform the data:
+Run dbt to load, transform, and test the data:
 
 ```bash
-cd dbt_hackernews
-dbt deps
-dbt seed
-dbt run
+cd dbt_ecommerce
+dbt build
 ```
 
+Staging models `ref()` their seeds, so a single `dbt build` loads the seeds, builds the models,
+and runs every generated test in one dependency-ordered pass — no separate `dbt seed`/`dbt run`
+needed, even on a brand-new database. (The individual `dbt deps`, `dbt seed`, and `dbt run`
+commands still work if you'd rather drive the steps yourself; the generated project declares no
+packages, so `dbt deps` is a no-op.)
+
 Your analytics-ready dataset is now in DuckDB!
 
 To target Postgres instead, install the extra and pass `--adapter postgres`:
 
 ```bash
 pip install "model2data[postgres]"
-model2data --file examples/hackernews.dbml --rows 200 --seed 42 --adapter postgres
+model2data --file examples/ecommerce.dbml --rows 200 --seed 42 --adapter postgres
 ```
 
 Connection details are read from environment variables (`MODEL2DATA_PG_HOST`, `MODEL2DATA_PG_PORT`, `MODEL2DATA_PG_USER`, `MODEL2DATA_PG_PASSWORD`, `MODEL2DATA_PG_DATABASE`), defaulting to `localhost:5432` with a `postgres`/`postgres` user for local development.
@@ -174,10 +155,11 @@ After generation, the CLI prints a short summary — tables and rows generated,
 Pass `--unit-tests` to also generate deterministic dbt unit test fixtures (`models/staging/ut_stg_<table>.yml`) from the actually-generated seed rows:
 
 ```bash
-model2data --file examples/hackernews.dbml --rows 200 --seed 42 --unit-tests
+model2data --file examples/ecommerce.dbml --rows 200 --seed 42 --unit-tests
 ```
 
-This targets dbt-core's native unit testing feature, which requires **dbt-core >= 1.8**. Since this project only requires `dbt-core>=1.5.0` by default, unit test generation is opt-in — leave the flag off if your dbt-core version is older.
+This targets dbt-core's native unit testing feature, which works out of the box with the base
+install — see [dbt-core versions](#dbt-core-versions) below.
 
 ---
 
@@ -189,11 +171,11 @@ The generated dbt project includes:
 dbt_{project_name}/
 ├── seeds/
 │   └── raw/
+│       ├── __seed_config.yml  # seed descriptions + column-type overrides
 │       ├── table1.csv
 │       └── table2.csv
 ├── models/
 │   └── staging/
-│       ├── __sources.yml
 │       ├── stg_table1.sql
 │       ├── stg_table1.yml
 │       ├── ut_stg_table1.yml  # only with --unit-tests
@@ -207,17 +189,44 @@ dbt_{project_name}/
 └── {project_name}_profile.duckdb  # DuckDB adapter only
 ```
 
-- **Seeds**: CSV files with generated synthetic data.
-- **Staging Models**: Basic dbt models that load from seeds.
-- **Sources & Tests**: YAML configs defining sources and column tests (`not_null`, `unique`,
-  `relationships`, and `accepted_values` for DBML `Enum`-typed columns). Table and column
-  `Note` text from the DBML becomes `description:` fields.
+- **Seeds**: CSV files with generated synthetic data, plus `__seed_config.yml` — each seed's
+  `description:` (from the table's DBML `Note`) and the column-type overrides that keep
+  all-digit text columns (barcodes, zero-padded postcodes, ...) from being loaded as integers.
+- **Staging Models**: Basic dbt models that `ref()` their seed. Using `ref()` rather than
+  declaring the seeds as dbt `sources` is what gives each model a real DAG edge to the seed
+  behind it, so one `dbt build` orders seeds before models on a fresh database.
+- **Tests**: A YAML per staging model with column tests (`not_null`, `unique`, `relationships`,
+  and `accepted_values` for DBML `Enum`-typed columns). Column `Note` text from the DBML becomes
+  `description:` fields.
 - **Composite key tests**: Composite primary/unique keys declared in an `indexes { }` block get
   a singular SQL test under `data-tests/`, dbt's configured `test-paths`.
 - **Profiles**: Pre-configured for DuckDB (file-based) or Postgres (via env vars), with schema handling.
 - **Unit tests** (opt-in via `--unit-tests`): `models/staging/ut_stg_<table>.yml` fixtures built
   from real generated rows, co-located with each staging model so dbt (which only parses unit
-  tests from `model-paths`) picks them up. Requires dbt-core >= 1.8.
+  tests from `model-paths`) picks them up.
+
+---
+
+## Using model2data with an LLM
+
+If you want to go from a plain-English description of a data model straight to a running,
+demo-ready dbt project, [LLMS.md](LLMS.md) is written for an LLM/agent to read: it covers the
+full DBML feature set model2data understands (enums, notes, defaults, composite keys, both
+relationship syntaxes, self-references) and the exact command sequence to run. Point an
+LLM-backed coding assistant at it and describe your data model — it can author the DBML and run
+model2data for you.
+
+---
+
+## dbt-core versions
+
+model2data requires **dbt-core >= 1.11**, tracking [dbt's own version support
+policy](https://docs.getdbt.com/docs/dbt-versions): dbt Labs supports each minor release for one
+year, and 1.11 is the oldest that still is. Generated projects build cleanly — no deprecation
+warnings — on every supported dbt-core version, and CI proves it on each push by running a real
+`dbt build` against both the stated floor and the newest release.
+
+If you're pinned to an older dbt-core, use model2data 0.5.x, which supported down to 1.8.5.
 
 ---
 
@@ -232,24 +241,32 @@ dbt_{project_name}/
 
 ## Limitations
 
-- Supports basic DBML features; complex constraints or advanced SQL types may not be fully handled.
-- Synthetic data generation is heuristic-based and may not perfectly mimic real-world distributions or edge cases.
+- Synthetic data generation is heuristic-based (typed generation, name-aware inference, enum/default awareness) and may not perfectly mimic real-world distributions or edge cases.
 - DuckDB and Postgres are supported today; other databases require manual profile adjustments.
 - No support for incremental models or advanced dbt features in generated projects.
+- Composite foreign keys (across a bridge/join table) are generated as independent single-column FKs — each column's values are individually valid, but the *combination* isn't guaranteed to match a real parent composite key unless that key is separately enforced via `indexes { }`.
+- Any DBML the parser can't fully make sense of (a malformed line, a ref pointing at an unknown table, an unrecognized column definition) is reported as a warning in the CLI's summary rather than silently dropped — check that summary after generating from a schema you didn't author yourself.
 
 ---
 
-## Roadmap
+## Project status
+
+As of `1.0.0`, model2data is considered **feature-complete for its intended use case**: turning a
+DBML schema into realistic synthetic data and a runnable dbt project, reliably. There's no active
+roadmap of new capabilities planned — the focus from here is maintenance: bug fixes, keeping pace
+with new dbt-core releases, and reviewing community contributions.
+
+Ideas that came up during development but were deliberately left out of scope, in case anyone
+wants to pick them up as a contribution:
+
+- Additional database adapters (e.g. Snowflake, BigQuery).
+- A rule-based semantic layer scaffold (`semantic_models.yml`/basic metrics) derived from the
+  parsed schema shape.
+- Example mart-layer models on top of staging (the generated `dbt_project.yml` carries a
+  ready-to-uncomment `marts` schema/materialization config for this).
+- Locale-aware generation (`--locale`) for non-English/US synthetic data.
 
-- [x] Postgres adapter support (`--adapter postgres`)
-- [x] Name-aware synthetic data (email, name, address, phone, etc. instead of generic text)
-- [x] Post-run generation summary (tables, rows, relationships, unmapped columns)
-- [x] DBML `Enum` support, real table/column notes as dbt descriptions, composite keys from
-      `indexes { }`, `default:` values, and opt-in deterministic dbt unit test scaffolding
-      (`--unit-tests`)
-- [ ] Additional database adapters (e.g., Snowflake, BigQuery).
-- [ ] Enhanced data type handling and custom generators.
-- [ ] Improved schema exploration and developer tooling.
+See [CONTRIBUTING.md](CONTRIBUTING.md) if you'd like to work on any of these.
 
 ---
 
@@ -277,7 +294,7 @@ MIT License. See LICENSE for details.
 
 <p align="center">
   <a href="https://www.jbanalytica.com">
-    <img src="assets/jba-icon-dark-bg.svg" alt="JB Analytica" height="40">
+    <img src="https://raw.githubusercontent.com/JB-Analytica/model2data/main/assets/jba-icon-dark-bg.svg" alt="JB Analytica" height="40">
   </a>
   <br>
   Built and maintained by <a href="https://www.jbanalytica.com"><strong>JB Analytica</strong></a> —