|
11 | 11 |
|
12 | 12 | ---
|
13 | 13 |
|
14 |
| -<p align="left"> |
15 |
| - <a href="https://databrickslabs.github.io/dlt-meta/"> |
16 |
| - <img src="https://img.shields.io/badge/DOCS-PASSING-green?style=for-the-badge" alt="Documentation Status"/> |
17 |
| - </a> |
18 |
| - <a href="https://pypi.org/project/dlt-meta/"> |
19 |
| - <img src="https://img.shields.io/badge/PYPI-v%200.0.9-green?style=for-the-badge" alt="Latest Python Release"/> |
20 |
| - </a> |
21 |
| - <a href="https://github.com/databrickslabs/dlt-meta/actions/workflows/onpush.yml"> |
22 |
| - <img src="https://img.shields.io/github/workflow/status/databrickslabs/dlt-meta/build/main?style=for-the-badge" |
23 |
| - alt="GitHub Workflow Status (branch)"/> |
24 |
| - </a> |
25 |
| - <a href="https://codecov.io/gh/databrickslabs/dlt-meta"> |
26 |
| - <img src="https://img.shields.io/codecov/c/github/databrickslabs/dlt-meta?style=for-the-badge&token=2CxLj3YBam" |
27 |
| - alt="codecov"/> |
28 |
| - </a> |
29 |
| - <a href="https://pypistats.org/packages/dl-meta"> |
30 |
| - <img src="https://img.shields.io/pypi/dm/dlt-meta?style=for-the-badge" alt="downloads"/> |
31 |
| - </a> |
32 |
| - <a href="https://github.com/PyCQA/flake8"> |
33 |
| - <img src="https://img.shields.io/badge/FLAKE8-FLAKE8-lightgrey?style=for-the-badge" |
34 |
| - alt="We use flake8 for formatting"/> |
35 |
| - </a> |
36 |
| -</p> |
37 |
| - |
38 |
| -[](<[https://codecov.io/github/databrickslabs/dlt-meta](https://github.com/databrickslabs/dlt-meta)>) |
| 14 | +[](https://databrickslabs.github.io/dlt-meta/) [](https://pypi.org/project/dlt-meta/) [](https://github.com/databrickslabs/dlt-meta/actions/workflows/onpush.yml) [](https://codecov.io/gh/databrickslabs/dlt-meta) [](https://github.com/PyCQA/flake8) [](https://pepy.tech/projects/dlt-meta) |
39 | 15 |
|
40 | 16 | ---
|
41 | 17 |
|
| 18 | + |
42 | 19 | # Project Overview
|
43 |
| -`DLT-META` is a metadata-driven framework designed to work with [Delta Live Tables](https://www.databricks.com/product/delta-live-tables). This framework enables the automation of bronze and silver data pipelines by leveraging metadata recorded in an onboarding JSON file. This file, known as the Dataflowspec, serves as the data flow specification, detailing the source and target metadata required for the pipelines. |
| 20 | +`DLT-META` is a metadata-driven framework designed to work with [Lakeflow Declarative Pipelines](https://www.databricks.com/product/data-engineering/lakeflow-declarative-pipelines). This framework enables the automation of bronze and silver data pipelines by leveraging metadata recorded in an onboarding JSON file. This file, known as the Dataflowspec, serves as the data flow specification, detailing the source and target metadata required for the pipelines. |
44 | 21 |
|
45 |
| -In practice, a single generic DLT pipeline reads the Dataflowspec and uses it to orchestrate and run the necessary data processing workloads. This approach streamlines the development and management of data pipelines, allowing for a more efficient and scalable data processing workflow |
| 22 | +In practice, a single generic pipeline reads the Dataflowspec and uses it to orchestrate and run the necessary data processing workloads. This approach streamlines the development and management of data pipelines, allowing for a more efficient and scalable data processing workflow |
46 | 23 |
|
47 | 24 | ### Components:
|
48 | 25 |
|
@@ -82,6 +59,8 @@ In practice, a single generic DLT pipeline reads the Dataflowspec and uses it to
|
82 | 59 | | Liquid cluster support | Bronze, Bronze Quarantine, Silver tables|
|
83 | 60 | | [DLT-META CLI](https://databrickslabs.github.io/dlt-meta/getting_started/dltmeta_cli/) | ```databricks labs dlt-meta onboard```, ```databricks labs dlt-meta deploy``` |
|
84 | 61 | | Bronze and Silver pipeline chaining | Deploy dlt-meta pipeline with ```layer=bronze_silver``` option using Direct publishing mode |
|
| 62 | +| [DLT Sinks](https://docs.databricks.com/aws/en/delta-live-tables/dlt-sinks) |Supported formats:external ```delta table```, ```kafka```.Bronze, Silver layers| |
| 63 | +| [Databricks Asset Bundles](https://docs.databricks.com/aws/en/dev-tools/bundles/) | Supported |
85 | 64 |
|
86 | 65 | ## Getting Started
|
87 | 66 |
|
@@ -121,36 +100,47 @@ databricks auth login --host WORKSPACE_HOST
|
121 | 100 |
|
122 | 101 | If you want to run existing demo files please follow these steps before running onboard command:
|
123 | 102 |
|
124 |
| -```commandline |
| 103 | +1. Clone dlt-meta: |
| 104 | + ```commandline |
125 | 105 | git clone https://github.com/databrickslabs/dlt-meta.git
|
126 |
| -``` |
| 106 | + ``` |
127 | 107 |
|
128 |
| -```commandline |
| 108 | +2. Navigate to project directory: |
| 109 | + ```commandline |
129 | 110 | cd dlt-meta
|
130 |
| -``` |
| 111 | + ``` |
131 | 112 |
|
132 |
| -```commandline |
| 113 | +3. Create Python virtual environment: |
| 114 | + ```commandline |
133 | 115 | python -m venv .venv
|
134 |
| -``` |
| 116 | + ``` |
135 | 117 |
|
136 |
| -```commandline |
| 118 | +4. Activate virtual environment: |
| 119 | + ```commandline |
137 | 120 | source .venv/bin/activate
|
138 |
| -``` |
| 121 | + ``` |
139 | 122 |
|
140 |
| -```commandline |
141 |
| - pip install databricks-sdk |
142 |
| -``` |
| 123 | +5. Install required packages: |
| 124 | + ```commandline |
| 125 | + # Core requirements |
| 126 | + pip install "PyYAML>=6.0" setuptools databricks-sdk |
| 127 | + |
| 128 | + # Development requirements |
| 129 | + pip install delta-spark==3.0.0 pyspark==3.5.5 pytest>=7.0.0 coverage>=7.0.0 |
| 130 | + |
| 131 | + # Integration test requirements |
| 132 | + pip install "typer[all]==0.6.1" |
| 133 | + ``` |
143 | 134 |
|
144 |
| -```commandline |
| 135 | +6. Set environment variables: |
| 136 | + ```commandline |
145 | 137 | dlt_meta_home=$(pwd)
|
146 |
| -``` |
147 |
| - |
148 |
| -```commandline |
149 | 138 | export PYTHONPATH=$dlt_meta_home
|
150 |
| -``` |
151 |
| -```commandline |
| 139 | + ``` |
| 140 | +7. Run onboarding command: |
| 141 | + ```commandline |
152 | 142 | databricks labs dlt-meta onboard
|
153 |
| -``` |
| 143 | + ``` |
154 | 144 | 
|
155 | 145 |
|
156 | 146 |
|
|
0 commit comments