datalex-cli 1.8.2__tar.gz → 1.11.0__tar.gz

datalex_cli-1.11.0/PKG-INFO

@@ -0,0 +1,292 @@
+Metadata-Version: 2.4
+Name: datalex-cli
+Version: 1.11.0
+Summary: Git-native data modeling for dbt users
+Author-email: DuckCode AI Labs <hello@duckcode.ai>
+License: MIT
+Project-URL: Homepage, https://duckcode.ai
+Project-URL: Repository, https://github.com/duckcode-ai/DataLex
+Project-URL: Issues, https://github.com/duckcode-ai/DataLex/issues
+Keywords: dbt,data-modeling,yaml,git-native,erd,data-warehouse
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: jsonschema>=4.0
+Provides-Extra: serve
+Requires-Dist: nodejs-wheel<23,>=20; extra == "serve"
+Provides-Extra: draft
+Requires-Dist: anthropic>=0.40.0; extra == "draft"
+Provides-Extra: draft-openai
+Requires-Dist: openai>=1.30.0; extra == "draft-openai"
+Provides-Extra: draft-gemini
+Requires-Dist: google-generativeai>=0.8.0; extra == "draft-gemini"
+Provides-Extra: draft-ollama
+Provides-Extra: draft-all
+Requires-Dist: anthropic>=0.40.0; extra == "draft-all"
+Requires-Dist: openai>=1.30.0; extra == "draft-all"
+Requires-Dist: google-generativeai>=0.8.0; extra == "draft-all"
+Provides-Extra: duckdb
+Requires-Dist: duckdb>=0.9; extra == "duckdb"
+Provides-Extra: postgres
+Requires-Dist: psycopg2-binary; extra == "postgres"
+Provides-Extra: mysql
+Requires-Dist: mysql-connector-python; extra == "mysql"
+Provides-Extra: snowflake
+Requires-Dist: snowflake-connector-python; extra == "snowflake"
+Provides-Extra: bigquery
+Requires-Dist: google-cloud-bigquery; extra == "bigquery"
+Provides-Extra: databricks
+Requires-Dist: databricks-sql-connector; extra == "databricks"
+Provides-Extra: sqlserver
+Requires-Dist: pyodbc; extra == "sqlserver"
+Provides-Extra: redshift
+Requires-Dist: redshift-connector; extra == "redshift"
+Provides-Extra: all
+Requires-Dist: nodejs-wheel<23,>=20; extra == "all"
+Requires-Dist: anthropic>=0.40.0; extra == "all"
+Requires-Dist: openai>=1.30.0; extra == "all"
+Requires-Dist: google-generativeai>=0.8.0; extra == "all"
+Requires-Dist: duckdb>=0.9; extra == "all"
+Requires-Dist: psycopg2-binary; extra == "all"
+Requires-Dist: mysql-connector-python; extra == "all"
+Requires-Dist: snowflake-connector-python; extra == "all"
+Requires-Dist: google-cloud-bigquery; extra == "all"
+Requires-Dist: databricks-sql-connector; extra == "all"
+Requires-Dist: pyodbc; extra == "all"
+Requires-Dist: redshift-connector; extra == "all"
+Dynamic: license-file
+
+<div align="center">
+  <a href="https://duckcode.ai/" target="_blank" rel="noopener noreferrer">
+    <img src="Assets/DataLex.png" alt="DataLex by DuckCode AI Labs" width="220" />
+  </a>
+
+# DataLex
+
+**AI-first dbt adoption, contracts, diagrams, and manifest publishing.**
+
+DataLex is a local-first OSS workflow for teams that already use dbt. It scans
+your existing dbt project, lets AI propose business domains and contracts from
+dbt evidence, and writes reviewed DataLex artifacts back to Git.
+
+DataLex does not replace dbt. dbt remains the source of truth for SQL, model
+YAML, semantic metrics, tests, exposures, and enforced physical contracts.
+DataLex adds the business/domain layer above 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>
+  <a href="https://discord.gg/Dnm6bUvk">
+    <img src="https://img.shields.io/badge/Discord-Join%20Community-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Discord Community" />
+  </a>
+</p>
+</div>
+
+## Install from PyPI
+
+Use this path when you want DataLex on your machine or inside an existing dbt
+repo.
+
+```bash
+python3 -m pip install -U 'datalex-cli[serve]'
+datalex --version
+datalex serve
+```
+
+Open `http://localhost:3030`.
+
+To open DataLex directly on an existing dbt repo:
+
+```bash
+cd ~/path/to/your-dbt-project
+datalex serve --project-dir .
+```
+
+For warehouse drivers, add the matching extra:
+
+```bash
+python3 -m pip install -U 'datalex-cli[serve,duckdb]'
+python3 -m pip install -U 'datalex-cli[serve,postgres]'
+python3 -m pip install -U 'datalex-cli[serve,snowflake]'
+python3 -m pip install -U 'datalex-cli[serve,all]'
+```
+
+Requirements: Python 3.9+ and Git. The `[serve]` extra includes a portable Node
+runtime for the local UI.
+
+## Run with Docker
+
+Use Docker when you do not want to install Python packages on the host.
+
+```bash
+git clone https://github.com/duckcode-ai/DataLex.git
+cd DataLex
+docker build -t datalex:local .
+docker run --rm -p 3030:3001 datalex:local
+```
+
+To use Docker with an existing dbt repo:
+
+```bash
+cd ~/path/to/your-dbt-project
+docker run --rm -p 3030:3001 \
+  -v "$PWD":/workspace \
+  -e REPO_ROOT=/workspace \
+  -e DM_CLI=/app/datalex \
+  datalex:local
+```
+
+In the UI, choose `/workspace` as the dbt project path.
+
+## Core workflow
+
+```text
+Connect dbt repo -> AI Setup -> Readiness -> Generate -> Review -> Contracts -> Publish
+```
+
+1. **Connect** your dbt repo.
+2. **Set up AI** with OpenAI, Claude, or Ollama.
+3. **Scan readiness** from dbt manifest, YAML, metrics, tests, exposures, owners, and contracts.
+4. **Generate focused proposal packs** for one domain, model group, or metric family.
+5. **Review and certify** proposals before anything becomes trusted.
+6. **Publish** `datalex-manifest.json` from certified contracts.
+
+Generation requires a tested AI provider. Readiness works without AI, but
+DataLex will not create fake domains or placeholder contracts.
+
+## AI setup
+
+DataLex uses your dbt evidence to generate proposals:
+
+- `target/manifest.json`
+- dbt model YAML
+- semantic models and metrics
+- tests and relationships
+- exposures
+- owners and descriptions
+- existing dbt contracts
+- existing DataLex artifacts
+
+Provider settings are project-private and stored under:
+
+```text
+<your-dbt-project>/.datalex/agent/provider-settings.json
+```
+
+They are not written under versioned `DataLex/`, and API responses redact
+secrets.
+
+### Ollama example
+
+```bash
+ollama pull gemma4:12b
+ollama serve
+```
+
+In DataLex, open **AI Setup**, choose **Ollama**, set:
+
+```text
+Base URL: http://localhost:11434
+Model: gemma4:12b
+```
+
+Then click **Save** and **Test**.
+
+## What DataLex writes
+
+New OSS artifacts use this domain-first layout:
+
+```text
+DataLex/
+  datalex.yaml
+  domains/
+    commerce.yaml
+  commerce/
+    conceptual/
+    logical/
+    physical/
+    contracts/
+    proposals/
+    glossary/
+    semantic/
+  imported/
+    dbt/
+  generated/
+    dbt/
+  generated-sql/
+  Skills/
+```
+
+DataLex still reads older layouts for compatibility, but new UI actions write
+lowercase canonical paths.
+
+Only certified contracts and metric contracts enter `datalex-manifest.json`.
+Draft, reviewed, and rejected proposals stay out of the publish manifest.
+
+## Publish a manifest
+
+```bash
+datalex datalex manifest build DataLex --out DataLex/datalex-manifest.json
+```
+
+The manifest is the stable OSS handoff for downstream tools and future cloud
+flows. DQL is not required in the OSS repo. DataLex only shows DQL readiness
+when a project explicitly enables that integration.
+
+## Tutorials
+
+Start here:
+
+1. [Install and run DataLex](docs/tutorials/01-install-and-run.md)
+2. [Connect an existing dbt repo](docs/tutorials/02-connect-existing-dbt.md)
+3. [Configure AI with OpenAI, Claude, or Ollama](docs/tutorials/03-configure-ai.md)
+4. [Generate, review, and certify a proposal pack](docs/tutorials/04-generate-review-certify.md)
+5. [Publish the DataLex manifest](docs/tutorials/05-publish-manifest.md)
+6. [Run DataLex with Docker](docs/tutorials/06-docker.md)
+
+For the full flow in one place, read [Getting started](docs/getting-started.md).
+
+## For contributors
+
+```bash
+git clone https://github.com/duckcode-ai/DataLex.git
+cd DataLex
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -e '.[serve,duckdb]'
+npm --prefix packages/api-server install
+npm --prefix packages/web-app install
+datalex serve
+```
+
+Useful checks:
+
+```bash
+npm --prefix packages/api-server test
+npm --prefix packages/web-app run build
+python3 -m pytest tests/datalex packages/readiness_engine/tests
+```
+
+## Links
+
+- Docs: [docs/index.md](docs/index.md)
+- CLI reference: [docs/cli.md](docs/cli.md)
+- Enterprise OSS workflow: [docs/enterprise-oss-workflow.md](docs/enterprise-oss-workflow.md)
+- DataLex layout: [docs/datalex-layout.md](docs/datalex-layout.md)
+- Issues: [GitHub Issues](https://github.com/duckcode-ai/DataLex/issues)
+- Community: [Discord](https://discord.gg/Dnm6bUvk)

datalex_cli-1.11.0/README.md

@@ -0,0 +1,223 @@
+<div align="center">
+  <a href="https://duckcode.ai/" target="_blank" rel="noopener noreferrer">
+    <img src="Assets/DataLex.png" alt="DataLex by DuckCode AI Labs" width="220" />
+  </a>
+
+# DataLex
+
+**AI-first dbt adoption, contracts, diagrams, and manifest publishing.**
+
+DataLex is a local-first OSS workflow for teams that already use dbt. It scans
+your existing dbt project, lets AI propose business domains and contracts from
+dbt evidence, and writes reviewed DataLex artifacts back to Git.
+
+DataLex does not replace dbt. dbt remains the source of truth for SQL, model
+YAML, semantic metrics, tests, exposures, and enforced physical contracts.
+DataLex adds the business/domain layer above 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>
+  <a href="https://discord.gg/Dnm6bUvk">
+    <img src="https://img.shields.io/badge/Discord-Join%20Community-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Discord Community" />
+  </a>
+</p>
+</div>
+
+## Install from PyPI
+
+Use this path when you want DataLex on your machine or inside an existing dbt
+repo.
+
+```bash
+python3 -m pip install -U 'datalex-cli[serve]'
+datalex --version
+datalex serve
+```
+
+Open `http://localhost:3030`.
+
+To open DataLex directly on an existing dbt repo:
+
+```bash
+cd ~/path/to/your-dbt-project
+datalex serve --project-dir .
+```
+
+For warehouse drivers, add the matching extra:
+
+```bash
+python3 -m pip install -U 'datalex-cli[serve,duckdb]'
+python3 -m pip install -U 'datalex-cli[serve,postgres]'
+python3 -m pip install -U 'datalex-cli[serve,snowflake]'
+python3 -m pip install -U 'datalex-cli[serve,all]'
+```
+
+Requirements: Python 3.9+ and Git. The `[serve]` extra includes a portable Node
+runtime for the local UI.
+
+## Run with Docker
+
+Use Docker when you do not want to install Python packages on the host.
+
+```bash
+git clone https://github.com/duckcode-ai/DataLex.git
+cd DataLex
+docker build -t datalex:local .
+docker run --rm -p 3030:3001 datalex:local
+```
+
+To use Docker with an existing dbt repo:
+
+```bash
+cd ~/path/to/your-dbt-project
+docker run --rm -p 3030:3001 \
+  -v "$PWD":/workspace \
+  -e REPO_ROOT=/workspace \
+  -e DM_CLI=/app/datalex \
+  datalex:local
+```
+
+In the UI, choose `/workspace` as the dbt project path.
+
+## Core workflow
+
+```text
+Connect dbt repo -> AI Setup -> Readiness -> Generate -> Review -> Contracts -> Publish
+```
+
+1. **Connect** your dbt repo.
+2. **Set up AI** with OpenAI, Claude, or Ollama.
+3. **Scan readiness** from dbt manifest, YAML, metrics, tests, exposures, owners, and contracts.
+4. **Generate focused proposal packs** for one domain, model group, or metric family.
+5. **Review and certify** proposals before anything becomes trusted.
+6. **Publish** `datalex-manifest.json` from certified contracts.
+
+Generation requires a tested AI provider. Readiness works without AI, but
+DataLex will not create fake domains or placeholder contracts.
+
+## AI setup
+
+DataLex uses your dbt evidence to generate proposals:
+
+- `target/manifest.json`
+- dbt model YAML
+- semantic models and metrics
+- tests and relationships
+- exposures
+- owners and descriptions
+- existing dbt contracts
+- existing DataLex artifacts
+
+Provider settings are project-private and stored under:
+
+```text
+<your-dbt-project>/.datalex/agent/provider-settings.json
+```
+
+They are not written under versioned `DataLex/`, and API responses redact
+secrets.
+
+### Ollama example
+
+```bash
+ollama pull gemma4:12b
+ollama serve
+```
+
+In DataLex, open **AI Setup**, choose **Ollama**, set:
+
+```text
+Base URL: http://localhost:11434
+Model: gemma4:12b
+```
+
+Then click **Save** and **Test**.
+
+## What DataLex writes
+
+New OSS artifacts use this domain-first layout:
+
+```text
+DataLex/
+  datalex.yaml
+  domains/
+    commerce.yaml
+  commerce/
+    conceptual/
+    logical/
+    physical/
+    contracts/
+    proposals/
+    glossary/
+    semantic/
+  imported/
+    dbt/
+  generated/
+    dbt/
+  generated-sql/
+  Skills/
+```
+
+DataLex still reads older layouts for compatibility, but new UI actions write
+lowercase canonical paths.
+
+Only certified contracts and metric contracts enter `datalex-manifest.json`.
+Draft, reviewed, and rejected proposals stay out of the publish manifest.
+
+## Publish a manifest
+
+```bash
+datalex datalex manifest build DataLex --out DataLex/datalex-manifest.json
+```
+
+The manifest is the stable OSS handoff for downstream tools and future cloud
+flows. DQL is not required in the OSS repo. DataLex only shows DQL readiness
+when a project explicitly enables that integration.
+
+## Tutorials
+
+Start here:
+
+1. [Install and run DataLex](docs/tutorials/01-install-and-run.md)
+2. [Connect an existing dbt repo](docs/tutorials/02-connect-existing-dbt.md)
+3. [Configure AI with OpenAI, Claude, or Ollama](docs/tutorials/03-configure-ai.md)
+4. [Generate, review, and certify a proposal pack](docs/tutorials/04-generate-review-certify.md)
+5. [Publish the DataLex manifest](docs/tutorials/05-publish-manifest.md)
+6. [Run DataLex with Docker](docs/tutorials/06-docker.md)
+
+For the full flow in one place, read [Getting started](docs/getting-started.md).
+
+## For contributors
+
+```bash
+git clone https://github.com/duckcode-ai/DataLex.git
+cd DataLex
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -e '.[serve,duckdb]'
+npm --prefix packages/api-server install
+npm --prefix packages/web-app install
+datalex serve
+```
+
+Useful checks:
+
+```bash
+npm --prefix packages/api-server test
+npm --prefix packages/web-app run build
+python3 -m pytest tests/datalex packages/readiness_engine/tests
+```
+
+## Links
+
+- Docs: [docs/index.md](docs/index.md)
+- CLI reference: [docs/cli.md](docs/cli.md)
+- Enterprise OSS workflow: [docs/enterprise-oss-workflow.md](docs/enterprise-oss-workflow.md)
+- DataLex layout: [docs/datalex-layout.md](docs/datalex-layout.md)
+- Issues: [GitHub Issues](https://github.com/duckcode-ai/DataLex/issues)
+- Community: [Discord](https://discord.gg/Dnm6bUvk)