Skip to content

Commit f9b8e9f

Browse files
committed
Fix CI and improve docs
- Use uv sync --all-extras --dev to install dev dependencies - Clarify that Python config (config.py) is required, not YAML - Improve package description
1 parent e91cf37 commit f9b8e9f

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121
run: uv python install 3.12
2222

2323
- name: Install dependencies
24-
run: uv sync --dev
24+
run: uv sync --all-extras --dev
2525

2626
- name: Run unit tests
2727
run: uv run pytest tests/test_console.py tests/test_datasets.py -v
@@ -73,7 +73,7 @@ jobs:
7373
run: uv python install 3.12
7474

7575
- name: Install dependencies
76-
run: uv sync --dev
76+
run: uv sync --all-extras --dev
7777

7878
- name: Wait for Marquez
7979
run: |

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# sqlmesh-openlineage
22

3-
OpenLineage integration for SQLMesh. Emits per-model lineage events during SQLMesh runs without modifying SQLMesh itself.
3+
OpenLineage integration for SQLMesh. Automatically emits lineage events to Marquez or any OpenLineage-compatible backend.
44

55
## Features
66

@@ -24,6 +24,8 @@ uv add sqlmesh-openlineage
2424

2525
## Quick Start (CLI Users)
2626

27+
**Note:** This package requires Python-based SQLMesh configuration (`config.py`), not YAML configuration.
28+
2729
Add this to your `config.py`:
2830

2931
```python

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[project]
22
name = "sqlmesh-openlineage"
33
version = "0.1.0"
4-
description = "OpenLineage integration for SQLMesh"
4+
description = "OpenLineage integration for SQLMesh - emit lineage to Marquez"
55
readme = "README.md"
66
requires-python = ">= 3.9"
77
license = { text = "MIT" }

0 commit comments

Comments
 (0)