dbt-column-lineage 0.1.1__tar.gz

dbt_column_lineage-0.1.1/.gitignore

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

dbt_column_lineage-0.1.1/Dockerfile

@@ -0,0 +1,27 @@
+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=node-builder /frontend/out frontend/out
+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
+COPY src .
+
+CMD ["uvicorn", "app:app", "--host", "0.0.0.0", "--port", "8000", "--timeout-keep-alive", "600"]

dbt_column_lineage-0.1.1/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.1
+Name: dbt_column_lineage
+Version: 0.1.1
+Summary: A FastAPI application for dbt column lineage and dashboard management
+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
+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.1.1/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
+```

dbt_column_lineage-0.1.1/frontend/.env.development

@@ -0,0 +1 @@
+NEXT_PUBLIC_API_HOSTNAME=http://localhost:8000

dbt_column_lineage-0.1.1/frontend/.env.production

@@ -0,0 +1 @@
+NEXT_PUBLIC_API_HOSTNAME=''

dbt_column_lineage-0.1.1/frontend/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}

dbt_column_lineage-0.1.1/frontend/.gitignore

@@ -0,0 +1,36 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

dbt_column_lineage-0.1.1/frontend/README.md

@@ -0,0 +1,36 @@
+This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+
+This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

dbt_column_lineage-0.1.1/frontend/next.config.mjs

@@ -0,0 +1,8 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  reactStrictMode: false,
+  swcMinify: true,
+  output: 'export'
+};
+
+export default nextConfig;