datalex-cli 0.1.1__tar.gz → 0.2.1__tar.gz

{datalex_cli-0.1.1 → datalex_cli-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datalex-cli
-Version: 0.1.1
+Version: 0.2.1
 Summary: Git-native data modeling for dbt users
 Author-email: DuckCode AI Labs <hello@duckcode.ai>
 License: MIT
@@ -23,6 +23,8 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML>=6.0
 Requires-Dist: jsonschema>=4.0
+Provides-Extra: serve
+Requires-Dist: nodejs-bin<21,>=20; python_version < "3.13" and extra == "serve"
 Provides-Extra: duckdb
 Requires-Dist: duckdb>=0.9; extra == "duckdb"
 Provides-Extra: postgres
@@ -40,6 +42,7 @@ Requires-Dist: pyodbc; extra == "sqlserver"
 Provides-Extra: redshift
 Requires-Dist: redshift-connector; extra == "redshift"
 Provides-Extra: all
+Requires-Dist: nodejs-bin<21,>=20; python_version < "3.13" and extra == "all"
 Requires-Dist: duckdb>=0.9; extra == "all"
 Requires-Dist: psycopg2-binary; extra == "all"
 Requires-Dist: mysql-connector-python; extra == "all"
@@ -63,6 +66,9 @@ Point us at your dbt project and warehouse — we produce versioned, reviewable
 with contracts, lineage, ERDs, and clean round-trip back to dbt.
 
 <p align="center">
+  <a href="https://pypi.org/project/datalex-cli/">
+    <img src="https://img.shields.io/pypi/v/datalex-cli?style=for-the-badge&color=3b82f6&label=PyPI" alt="PyPI" />
+  </a>
   <a href="https://github.com/duckcode-ai/DataLex/blob/main/LICENSE">
     <img src="https://img.shields.io/github/license/duckcode-ai/DataLex?style=for-the-badge&color=22c55e" alt="MIT License" />
   </a>
@@ -79,22 +85,72 @@ with contracts, lineage, ERDs, and clean round-trip back to dbt.
   <img src="Assets/Overview.png" alt="DataLex Visual Studio — file tree, YAML editor, and React Flow ERD on the same entity" width="100%" />
 </p>
 
-## 60-second demo
+## Quickstart (recommended)
 
 ```bash
+pip install 'datalex-cli[serve]'       # CLI + bundled Node — one command, no prereqs
+datalex serve                          # opens http://localhost:3030
+```
+
+That's it. `[serve]` pulls a portable Node so you don't need to install
+Node separately — and yes, that's intentional. If you already have Node
+20+ on your PATH, plain `pip install datalex-cli` works too.
+
+**Working with your own dbt project?**
+
+```bash
+cd ~/my-dbt-project                    # folder containing dbt_project.yml
+datalex serve --project-dir .
+```
+
+DataLex auto-registers the folder as a project on first launch, so the
+browser opens directly into your real tree — no "set up a workspace"
+click-through. Every UI edit writes back to the original `.yml` files
+on disk. See **[docs/getting-started.md](docs/getting-started.md)** for
+the full path matrix (demo → local dbt → git URL → live warehouse).
+
+**Want your warehouse drivers too?**
+
+```bash
+pip install 'datalex-cli[serve,postgres]'        # or snowflake, bigquery, databricks…
+pip install 'datalex-cli[serve,all]'             # every driver + Node
+```
+
+### Pick a tutorial
+
+Once `datalex serve` is running, follow the path that matches what you
+have in hand:
+
+| You have...                                | Tutorial                                                           | Time  |
+|--------------------------------------------|--------------------------------------------------------------------|-------|
+| Nothing — just want the demo               | [Jaffle-shop one-click walkthrough](docs/tutorials/jaffle-shop-walkthrough.md) | 3 min |
+| An existing dbt project (folder or git)    | [Import an existing dbt project](docs/tutorials/import-existing-dbt.md)        | 5 min |
+| A live warehouse (Snowflake/Postgres/…)    | [Pull a warehouse schema](docs/tutorials/warehouse-pull.md)                    | 7 min |
+| CLI-only, no UI                            | [CLI dbt-sync tutorial](docs/tutorial-dbt-sync.md)                             | 5 min |
+
+New here? Start with **[docs/getting-started.md](docs/getting-started.md)** —
+it's the map across all four paths plus the mental model.
+
+## 60-second demo (offline, no warehouse)
+
+<p align="center">
+  <img src="demo/demo.gif" alt="DataLex dbt sync demo — build a DuckDB warehouse, sync into DataLex YAML, emit back to dbt with contracts enforced" width="100%" />
+</p>
+
+```bash
+pip install 'datalex-cli[duckdb]'
 git clone https://github.com/duckcode-ai/DataLex.git
 cd DataLex
-pip install -e '.[duckdb]'
 
 # 1. Build a local DuckDB warehouse (no external credentials)
 python examples/jaffle_shop_demo/setup.py
 
 # 2. Sync the dbt project into DataLex YAML
-./datalex datalex dbt sync examples/jaffle_shop_demo \
+datalex datalex dbt sync examples/jaffle_shop_demo \
     --out-root examples/jaffle_shop_demo/datalex-out
 
 # 3. Emit dbt-parseable YAML back, with contracts enforced
-./datalex datalex dbt emit examples/jaffle_shop_demo/datalex-out \
+datalex datalex dbt emit examples/jaffle_shop_demo/datalex-out \
     --out-dir examples/jaffle_shop_demo/dbt-out
 ```
 
@@ -145,14 +201,21 @@ per-dialect over time).
 
 ## Install
 
+From [PyPI](https://pypi.org/project/datalex-cli/):
+
+```bash
+pip install datalex-cli               # puts `datalex` on PATH
+pip install 'datalex-cli[duckdb]'     # add warehouse drivers you need
+```
+
+From source (for contributors or editable installs):
+
 ```bash
 git clone https://github.com/duckcode-ai/DataLex.git
 cd DataLex
-
 python3 -m venv .venv
 source .venv/bin/activate
-pip install -e .              # puts `datalex` on PATH
-pip install -e '.[duckdb]'    # add warehouse drivers you need
+pip install -e '.[duckdb]'
 
 # optional — only needed for the Visual Studio
 npm --prefix packages/api-server install
@@ -210,12 +273,28 @@ dbt parse
 
 ## Documentation
 
-- **[Tutorial: dbt sync in 5 minutes](docs/tutorial-dbt-sync.md)** — the
-  full jaffle_shop walkthrough with explanations.
+**Onboarding**
+
+- **[Getting started](docs/getting-started.md)** — the one-page map
+  covering install, the three GUI paths, and the mental model.
+- **[Jaffle-shop walkthrough](docs/tutorials/jaffle-shop-walkthrough.md)** —
+  3-minute offline demo of every UI feature.
+- **[Import an existing dbt project](docs/tutorials/import-existing-dbt.md)** —
+  5-minute bring-your-own-repo flow (local folder or git URL).
+- **[Pull a warehouse schema](docs/tutorials/warehouse-pull.md)** —
+  7-minute live-connection flow with inferred PKs/FKs and streaming
+  progress.
+- **[CLI dbt-sync tutorial](docs/tutorial-dbt-sync.md)** — original
+  CLI-only jaffle_shop walkthrough.
+
+**Reference**
+
 - **[DataLex layout reference](docs/datalex-layout.md)** — what each
   `kind:` file looks like and how the loader discovers them.
 - **[CLI cheat sheet](docs/cli.md)** — every `datalex datalex …` subcommand on
   one page.
+- **[API contracts](docs/api-contracts.md)** — HTTP API reference for
+  integrators.
 - **[Architecture](docs/architecture.md)** — core engine modules and
   end-to-end data flow.
 - Pre-DataLex specs have moved to [docs/archive/](docs/archive/).

{datalex_cli-0.1.1 → datalex_cli-0.2.1}/README.md

@@ -11,6 +11,9 @@ Point us at your dbt project and warehouse — we produce versioned, reviewable
 with contracts, lineage, ERDs, and clean round-trip back to dbt.
 
 <p align="center">
+  <a href="https://pypi.org/project/datalex-cli/">
+    <img src="https://img.shields.io/pypi/v/datalex-cli?style=for-the-badge&color=3b82f6&label=PyPI" alt="PyPI" />
+  </a>
   <a href="https://github.com/duckcode-ai/DataLex/blob/main/LICENSE">
     <img src="https://img.shields.io/github/license/duckcode-ai/DataLex?style=for-the-badge&color=22c55e" alt="MIT License" />
   </a>
@@ -27,22 +30,72 @@ with contracts, lineage, ERDs, and clean round-trip back to dbt.
   <img src="Assets/Overview.png" alt="DataLex Visual Studio — file tree, YAML editor, and React Flow ERD on the same entity" width="100%" />
 </p>
 
-## 60-second demo
+## Quickstart (recommended)
 
 ```bash
+pip install 'datalex-cli[serve]'       # CLI + bundled Node — one command, no prereqs
+datalex serve                          # opens http://localhost:3030
+```
+
+That's it. `[serve]` pulls a portable Node so you don't need to install
+Node separately — and yes, that's intentional. If you already have Node
+20+ on your PATH, plain `pip install datalex-cli` works too.
+
+**Working with your own dbt project?**
+
+```bash
+cd ~/my-dbt-project                    # folder containing dbt_project.yml
+datalex serve --project-dir .
+```
+
+DataLex auto-registers the folder as a project on first launch, so the
+browser opens directly into your real tree — no "set up a workspace"
+click-through. Every UI edit writes back to the original `.yml` files
+on disk. See **[docs/getting-started.md](docs/getting-started.md)** for
+the full path matrix (demo → local dbt → git URL → live warehouse).
+
+**Want your warehouse drivers too?**
+
+```bash
+pip install 'datalex-cli[serve,postgres]'        # or snowflake, bigquery, databricks…
+pip install 'datalex-cli[serve,all]'             # every driver + Node
+```
+
+### Pick a tutorial
+
+Once `datalex serve` is running, follow the path that matches what you
+have in hand:
+
+| You have...                                | Tutorial                                                           | Time  |
+|--------------------------------------------|--------------------------------------------------------------------|-------|
+| Nothing — just want the demo               | [Jaffle-shop one-click walkthrough](docs/tutorials/jaffle-shop-walkthrough.md) | 3 min |
+| An existing dbt project (folder or git)    | [Import an existing dbt project](docs/tutorials/import-existing-dbt.md)        | 5 min |
+| A live warehouse (Snowflake/Postgres/…)    | [Pull a warehouse schema](docs/tutorials/warehouse-pull.md)                    | 7 min |
+| CLI-only, no UI                            | [CLI dbt-sync tutorial](docs/tutorial-dbt-sync.md)                             | 5 min |
+
+New here? Start with **[docs/getting-started.md](docs/getting-started.md)** —
+it's the map across all four paths plus the mental model.
+
+## 60-second demo (offline, no warehouse)
+
+<p align="center">
+  <img src="demo/demo.gif" alt="DataLex dbt sync demo — build a DuckDB warehouse, sync into DataLex YAML, emit back to dbt with contracts enforced" width="100%" />
+</p>
+
+```bash
+pip install 'datalex-cli[duckdb]'
 git clone https://github.com/duckcode-ai/DataLex.git
 cd DataLex
-pip install -e '.[duckdb]'
 
 # 1. Build a local DuckDB warehouse (no external credentials)
 python examples/jaffle_shop_demo/setup.py
 
 # 2. Sync the dbt project into DataLex YAML
-./datalex datalex dbt sync examples/jaffle_shop_demo \
+datalex datalex dbt sync examples/jaffle_shop_demo \
     --out-root examples/jaffle_shop_demo/datalex-out
 
 # 3. Emit dbt-parseable YAML back, with contracts enforced
-./datalex datalex dbt emit examples/jaffle_shop_demo/datalex-out \
+datalex datalex dbt emit examples/jaffle_shop_demo/datalex-out \
     --out-dir examples/jaffle_shop_demo/dbt-out
 ```
 
@@ -93,14 +146,21 @@ per-dialect over time).
 
 ## Install
 
+From [PyPI](https://pypi.org/project/datalex-cli/):
+
+```bash
+pip install datalex-cli               # puts `datalex` on PATH
+pip install 'datalex-cli[duckdb]'     # add warehouse drivers you need
+```
+
+From source (for contributors or editable installs):
+
 ```bash
 git clone https://github.com/duckcode-ai/DataLex.git
 cd DataLex
-
 python3 -m venv .venv
 source .venv/bin/activate
-pip install -e .              # puts `datalex` on PATH
-pip install -e '.[duckdb]'    # add warehouse drivers you need
+pip install -e '.[duckdb]'
 
 # optional — only needed for the Visual Studio
 npm --prefix packages/api-server install
@@ -158,12 +218,28 @@ dbt parse
 
 ## Documentation
 
-- **[Tutorial: dbt sync in 5 minutes](docs/tutorial-dbt-sync.md)** — the
-  full jaffle_shop walkthrough with explanations.
+**Onboarding**
+
+- **[Getting started](docs/getting-started.md)** — the one-page map
+  covering install, the three GUI paths, and the mental model.
+- **[Jaffle-shop walkthrough](docs/tutorials/jaffle-shop-walkthrough.md)** —
+  3-minute offline demo of every UI feature.
+- **[Import an existing dbt project](docs/tutorials/import-existing-dbt.md)** —
+  5-minute bring-your-own-repo flow (local folder or git URL).
+- **[Pull a warehouse schema](docs/tutorials/warehouse-pull.md)** —
+  7-minute live-connection flow with inferred PKs/FKs and streaming
+  progress.
+- **[CLI dbt-sync tutorial](docs/tutorial-dbt-sync.md)** — original
+  CLI-only jaffle_shop walkthrough.
+
+**Reference**
+
 - **[DataLex layout reference](docs/datalex-layout.md)** — what each
   `kind:` file looks like and how the loader discovers them.
 - **[CLI cheat sheet](docs/cli.md)** — every `datalex datalex …` subcommand on
   one page.
+- **[API contracts](docs/api-contracts.md)** — HTTP API reference for
+  integrators.
 - **[Architecture](docs/architecture.md)** — core engine modules and
   end-to-end data flow.
 - Pre-DataLex specs have moved to [docs/archive/](docs/archive/).

{datalex_cli-0.1.1 → datalex_cli-0.2.1}/datalex_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datalex-cli
-Version: 0.1.1
+Version: 0.2.1
 Summary: Git-native data modeling for dbt users
 Author-email: DuckCode AI Labs <hello@duckcode.ai>
 License: MIT
@@ -23,6 +23,8 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML>=6.0
 Requires-Dist: jsonschema>=4.0
+Provides-Extra: serve
+Requires-Dist: nodejs-bin<21,>=20; python_version < "3.13" and extra == "serve"
 Provides-Extra: duckdb
 Requires-Dist: duckdb>=0.9; extra == "duckdb"
 Provides-Extra: postgres
@@ -40,6 +42,7 @@ Requires-Dist: pyodbc; extra == "sqlserver"
 Provides-Extra: redshift
 Requires-Dist: redshift-connector; extra == "redshift"
 Provides-Extra: all
+Requires-Dist: nodejs-bin<21,>=20; python_version < "3.13" and extra == "all"
 Requires-Dist: duckdb>=0.9; extra == "all"
 Requires-Dist: psycopg2-binary; extra == "all"
 Requires-Dist: mysql-connector-python; extra == "all"
@@ -63,6 +66,9 @@ Point us at your dbt project and warehouse — we produce versioned, reviewable
 with contracts, lineage, ERDs, and clean round-trip back to dbt.
 
 <p align="center">
+  <a href="https://pypi.org/project/datalex-cli/">
+    <img src="https://img.shields.io/pypi/v/datalex-cli?style=for-the-badge&color=3b82f6&label=PyPI" alt="PyPI" />
+  </a>
   <a href="https://github.com/duckcode-ai/DataLex/blob/main/LICENSE">
     <img src="https://img.shields.io/github/license/duckcode-ai/DataLex?style=for-the-badge&color=22c55e" alt="MIT License" />
   </a>
@@ -79,22 +85,72 @@ with contracts, lineage, ERDs, and clean round-trip back to dbt.
   <img src="Assets/Overview.png" alt="DataLex Visual Studio — file tree, YAML editor, and React Flow ERD on the same entity" width="100%" />
 </p>
 
-## 60-second demo
+## Quickstart (recommended)
 
 ```bash
+pip install 'datalex-cli[serve]'       # CLI + bundled Node — one command, no prereqs
+datalex serve                          # opens http://localhost:3030
+```
+
+That's it. `[serve]` pulls a portable Node so you don't need to install
+Node separately — and yes, that's intentional. If you already have Node
+20+ on your PATH, plain `pip install datalex-cli` works too.
+
+**Working with your own dbt project?**
+
+```bash
+cd ~/my-dbt-project                    # folder containing dbt_project.yml
+datalex serve --project-dir .
+```
+
+DataLex auto-registers the folder as a project on first launch, so the
+browser opens directly into your real tree — no "set up a workspace"
+click-through. Every UI edit writes back to the original `.yml` files
+on disk. See **[docs/getting-started.md](docs/getting-started.md)** for
+the full path matrix (demo → local dbt → git URL → live warehouse).
+
+**Want your warehouse drivers too?**
+
+```bash
+pip install 'datalex-cli[serve,postgres]'        # or snowflake, bigquery, databricks…
+pip install 'datalex-cli[serve,all]'             # every driver + Node
+```
+
+### Pick a tutorial
+
+Once `datalex serve` is running, follow the path that matches what you
+have in hand:
+
+| You have...                                | Tutorial                                                           | Time  |
+|--------------------------------------------|--------------------------------------------------------------------|-------|
+| Nothing — just want the demo               | [Jaffle-shop one-click walkthrough](docs/tutorials/jaffle-shop-walkthrough.md) | 3 min |
+| An existing dbt project (folder or git)    | [Import an existing dbt project](docs/tutorials/import-existing-dbt.md)        | 5 min |
+| A live warehouse (Snowflake/Postgres/…)    | [Pull a warehouse schema](docs/tutorials/warehouse-pull.md)                    | 7 min |
+| CLI-only, no UI                            | [CLI dbt-sync tutorial](docs/tutorial-dbt-sync.md)                             | 5 min |
+
+New here? Start with **[docs/getting-started.md](docs/getting-started.md)** —
+it's the map across all four paths plus the mental model.
+
+## 60-second demo (offline, no warehouse)
+
+<p align="center">
+  <img src="demo/demo.gif" alt="DataLex dbt sync demo — build a DuckDB warehouse, sync into DataLex YAML, emit back to dbt with contracts enforced" width="100%" />
+</p>
+
+```bash
+pip install 'datalex-cli[duckdb]'
 git clone https://github.com/duckcode-ai/DataLex.git
 cd DataLex
-pip install -e '.[duckdb]'
 
 # 1. Build a local DuckDB warehouse (no external credentials)
 python examples/jaffle_shop_demo/setup.py
 
 # 2. Sync the dbt project into DataLex YAML
-./datalex datalex dbt sync examples/jaffle_shop_demo \
+datalex datalex dbt sync examples/jaffle_shop_demo \
     --out-root examples/jaffle_shop_demo/datalex-out
 
 # 3. Emit dbt-parseable YAML back, with contracts enforced
-./datalex datalex dbt emit examples/jaffle_shop_demo/datalex-out \
+datalex datalex dbt emit examples/jaffle_shop_demo/datalex-out \
     --out-dir examples/jaffle_shop_demo/dbt-out
 ```
 
@@ -145,14 +201,21 @@ per-dialect over time).
 
 ## Install
 
+From [PyPI](https://pypi.org/project/datalex-cli/):
+
+```bash
+pip install datalex-cli               # puts `datalex` on PATH
+pip install 'datalex-cli[duckdb]'     # add warehouse drivers you need
+```
+
+From source (for contributors or editable installs):
+
 ```bash
 git clone https://github.com/duckcode-ai/DataLex.git
 cd DataLex
-
 python3 -m venv .venv
 source .venv/bin/activate
-pip install -e .              # puts `datalex` on PATH
-pip install -e '.[duckdb]'    # add warehouse drivers you need
+pip install -e '.[duckdb]'
 
 # optional — only needed for the Visual Studio
 npm --prefix packages/api-server install
@@ -210,12 +273,28 @@ dbt parse
 
 ## Documentation
 
-- **[Tutorial: dbt sync in 5 minutes](docs/tutorial-dbt-sync.md)** — the
-  full jaffle_shop walkthrough with explanations.
+**Onboarding**
+
+- **[Getting started](docs/getting-started.md)** — the one-page map
+  covering install, the three GUI paths, and the mental model.
+- **[Jaffle-shop walkthrough](docs/tutorials/jaffle-shop-walkthrough.md)** —
+  3-minute offline demo of every UI feature.
+- **[Import an existing dbt project](docs/tutorials/import-existing-dbt.md)** —
+  5-minute bring-your-own-repo flow (local folder or git URL).
+- **[Pull a warehouse schema](docs/tutorials/warehouse-pull.md)** —
+  7-minute live-connection flow with inferred PKs/FKs and streaming
+  progress.
+- **[CLI dbt-sync tutorial](docs/tutorial-dbt-sync.md)** — original
+  CLI-only jaffle_shop walkthrough.
+
+**Reference**
+
 - **[DataLex layout reference](docs/datalex-layout.md)** — what each
   `kind:` file looks like and how the loader discovers them.
 - **[CLI cheat sheet](docs/cli.md)** — every `datalex datalex …` subcommand on
   one page.
+- **[API contracts](docs/api-contracts.md)** — HTTP API reference for
+  integrators.
 - **[Architecture](docs/architecture.md)** — core engine modules and
   end-to-end data flow.
 - Pre-DataLex specs have moved to [docs/archive/](docs/archive/).