https://github.com/louisguitton/dbt-metadata-utils
Parse dbt artifacts and search dbt models with Algolia
https://github.com/louisguitton/dbt-metadata-utils
algolia dbt metadata search
Last synced: 6 months ago
JSON representation
Parse dbt artifacts and search dbt models with Algolia
- Host: GitHub
- URL: https://github.com/louisguitton/dbt-metadata-utils
- Owner: louisguitton
- Created: 2020-12-26T15:48:49.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-05-06T23:56:42.000Z (over 4 years ago)
- Last Synced: 2025-04-24T02:53:18.911Z (6 months ago)
- Topics: algolia, dbt, metadata, search
- Language: Jupyter Notebook
- Homepage: https://dbt-metadata-utils.guitton.co/
- Size: 2.52 MB
- Stars: 52
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# dbt-metadata-utils
> Parse dbt artifacts, enrich them, and search them with Algolia.
Check the online demo at
## Prerequisites
All you will need is:
- your already existing dbt project in a git repository locally
- clone dbt-metadata-utils on the same machine than your dbt project
- create one Algolia account (and API key)
- create one Algolia app inside that account
- create `.env` file following `.env.example` and fill in your config values from the Algolia dashboard
For the dbt project, we will use one of the [example projects](https://docs.getdbt.com/faqs/example-projects/) listed on the dbt docs: the [jaffle_shop](https://github.com/fishtown-analytics/jaffle_shop) codebase.
## Local Usage
For testing things out with this project, one option is to work in your local environment.
Install the dependencies (in a virtual environment) with the following command:
```sh
make install
```
Then index records into your Algolia search index:
```sh
make update-git-metadata
make update-index
```
Finally, start the search webapp:
```sh
make run
```
## Docker-compose Usage
Whether you want a way to deploy dbt-metadata-utils in production or if simply you're running into issues, you can start the project using `docker-compose`:
```sh
docker-compose up
open http://localhost:8080
```
## Development
```sh
make develop
```