dbt-column-lineage 0.0.1a0__tar.gz

dbt_column_lineage-0.0.1a0/.gitignore

@@ -0,0 +1,7 @@
+.idea
+.envrc
+data/catalog.json
+data/manifest.json
+deploy_aws.sh
+test/*.py
+out/*

dbt_column_lineage-0.0.1a0/Dockerfile

@@ -0,0 +1,28 @@
+FROM node:21 as node-builder
+WORKDIR /frontend
+
+ENV NODE_ENV production
+COPY frontend/package-lock.json frontend/package.json ./
+RUN npm ci
+COPY frontend .
+RUN npm run build
+
+FROM python:3.12 as python-builder
+WORKDIR /app
+
+COPY ./requirements.txt .
+RUN pip install --upgrade pip && \
+    pip install --no-cache-dir -r requirements.txt
+
+FROM python:3.12-slim-bookworm
+
+WORKDIR /app
+COPY --from=python-builder /usr/local/lib/python3.12/site-packages/ /usr/local/lib/python3.12/site-packages/
+COPY --from=python-builder /usr/local/bin/uvicorn /usr/local/bin/
+COPY data/*.json data/
+
+WORKDIR /app/src/dbt_column_lineage
+COPY src/dbt_column_lineage .
+COPY --from=node-builder /frontend/out frontend_out
+
+CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000", "--timeout-keep-alive", "600"]

dbt_column_lineage-0.0.1a0/MANIFEST.in

@@ -0,0 +1,2 @@
+include data/*
+include src/dbt_column_lineage/frontend_out/**/*

dbt_column_lineage-0.0.1a0/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.1
+Name: dbt_column_lineage
+Version: 0.0.1a0
+Summary: A tool for dbt column lineage
+Author-email: Your Name <your.email@example.com>
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: sqlglot==24.1.0
+Requires-Dist: fastapi==0.112.1
+Requires-Dist: uvicorn==0.30.6
+Requires-Dist: requests==2.31.0
+Requires-Dist: pytz==2024.1
+Requires-Dist: looker-sdk==24.4.0
+Requires-Dist: python-liquid==1.12.1
+Requires-Dist: itsdangerous==2.2.0
+Requires-Dist: typer==0.12.5
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+
+# dbt-column-lineage
+This is a tool to visualize the colulmn level lineage of dbt models. It uses the `manifest.json` and `catalog.json` files generated by dbt to create a graph of the lineage of the models. It is a web application that uses a Flask backend and a Next.js frontend.
+
+# quickstart
+
+To run the application, first clone the repository:
+```
+git clone git@github.com:Oisix/dbt-column-lineage.git
+cd dbt-column-lineage
+```
+
+Then copy the `manifest.json` and `catalog.json` files to the `data` directory:
+```
+export DBT_PROJECT_PATH=(your dbt project path)
+cp $DBT_PROJECT_PATH/target/manifest.json data/manifest.json
+cp $DBT_PROJECT_PATH/target/catalog.json data/catalog.json
+```
+
+Then build and run the docker container:
+```
+docker build -t dbt_column_lineage .
+docker run -p 8000:8000 dbt_column_lineage
+```
+after the container is running,
+Let's access http://localhost:8000
+
+# development
+
+To develop the application, you will need to run the backend and frontend separately.
+
+## for backend
+
+activate venv and run the following commands:
+```
+python3 -m venv venv
+source venv/bin/activate
+
+pip install --upgrade pip
+pip install -r requirements.txt
+
+python src/app.py
+```
+
+## for frontend
+
+run the following commands:
+```
+npm install
+npm run dev
+```
+after the frontend is running,
+Let's access http://localhost:3000
+
+## for Google OAuth login test (optional)
+
+If you want to test the OAuth login, you can use the following commands:
+```
+export GOOGLE_CLIENT_ID=(your client id)
+export GOOGLE_CLIENT_SECRET=(your client secret)
+docker build -t test .
+docker run -p 8000:8000 -e USE_OAUTH=true -e GOOGLE_CLIENT_ID=$GOOGLE_CLIENT_ID -e GOOGLE_CLIENT_SECRET=$GOOGLE_CLIENT_SECRET -e DEBUG_MODE=true test
+```

dbt_column_lineage-0.0.1a0/README.md

@@ -0,0 +1,62 @@
+# dbt-column-lineage
+This is a tool to visualize the colulmn level lineage of dbt models. It uses the `manifest.json` and `catalog.json` files generated by dbt to create a graph of the lineage of the models. It is a web application that uses a Flask backend and a Next.js frontend.
+
+# quickstart
+
+To run the application, first clone the repository:
+```
+git clone git@github.com:Oisix/dbt-column-lineage.git
+cd dbt-column-lineage
+```
+
+Then copy the `manifest.json` and `catalog.json` files to the `data` directory:
+```
+export DBT_PROJECT_PATH=(your dbt project path)
+cp $DBT_PROJECT_PATH/target/manifest.json data/manifest.json
+cp $DBT_PROJECT_PATH/target/catalog.json data/catalog.json
+```
+
+Then build and run the docker container:
+```
+docker build -t dbt_column_lineage .
+docker run -p 8000:8000 dbt_column_lineage
+```
+after the container is running,
+Let's access http://localhost:8000
+
+# development
+
+To develop the application, you will need to run the backend and frontend separately.
+
+## for backend
+
+activate venv and run the following commands:
+```
+python3 -m venv venv
+source venv/bin/activate
+
+pip install --upgrade pip
+pip install -r requirements.txt
+
+python src/app.py
+```
+
+## for frontend
+
+run the following commands:
+```
+npm install
+npm run dev
+```
+after the frontend is running,
+Let's access http://localhost:3000
+
+## for Google OAuth login test (optional)
+
+If you want to test the OAuth login, you can use the following commands:
+```
+export GOOGLE_CLIENT_ID=(your client id)
+export GOOGLE_CLIENT_SECRET=(your client secret)
+docker build -t test .
+docker run -p 8000:8000 -e USE_OAUTH=true -e GOOGLE_CLIENT_ID=$GOOGLE_CLIENT_ID -e GOOGLE_CLIENT_SECRET=$GOOGLE_CLIENT_SECRET -e DEBUG_MODE=true test
+```