Skip to content

Commit

Permalink
docs(README): better output diagrams via tree
Browse files Browse the repository at this point in the history
  • Loading branch information
gwenwindflower authored Apr 23, 2024
1 parent 60418aa commit 648ba23
Showing 1 changed file with 40 additions and 5 deletions.
45 changes: 40 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ _**Disclaimer**: This project is not affiliated with dbt Labs in any way. It is

It's designed to be super fast and easy to use with a friendly TUI that fast forwards you to writing meaningful dbt models as quickly as possible.

Still confused? No worries! Check out the [example output diagrams](#without-scaffolding-a-dbt-project) and it will make sense.

### It's the **_easy button_** for dbt projects.

#### Quickstart
Expand Down Expand Up @@ -120,16 +122,44 @@ It will guide you through inputting the necessary information to generate your `

The output will be a directory with the following structure:

```
your_build_dir/
### Without scaffolding a dbt project

```terminal
your/build/dir/models/staging/schema_name/
β”œβ”€β”€ _sources.yml
β”œβ”€β”€ stg_model_a.sql
└── etc...
β”œβ”€β”€ stg_raw_customers.sql
β”œβ”€β”€ stg_raw_items.sql
β”œβ”€β”€ stg_raw_orders.sql
β”œβ”€β”€ stg_raw_products.sql
β”œβ”€β”€ stg_raw_stores.sql
└── stg_raw_supplies.sql
```

### With scaffolding a dbt project

```terminal
your/build/dir
β”œβ”€β”€ analyses
β”œβ”€β”€ data-tests
β”œβ”€β”€ dbt_project.yml
β”œβ”€β”€ macros
β”œβ”€β”€ models
β”‚Β Β  β”œβ”€β”€ marts
β”‚Β Β  └── staging
β”‚Β Β  β”œβ”€β”€ _sources.yml
β”‚Β Β  β”œβ”€β”€ stg_raw_customers.sql
β”‚Β Β  β”œβ”€β”€ stg_raw_items.sql
β”‚Β Β  β”œβ”€β”€ stg_raw_orders.sql
β”‚Β Β  β”œβ”€β”€ stg_raw_products.sql
β”‚Β Β  β”œβ”€β”€ stg_raw_stores.sql
β”‚Β Β  └── stg_raw_supplies.sql
β”œβ”€β”€ seeds
└── snapshots
```

### πŸ¦™ LLM features

`tbd` has some neat alpha features that infer documentation and tests for your columns. There are multiple supported LLMs via API: Groq running Llama 3 70B, Anthropic Claude 3 Opus, and OpenAI GPT-4 Turbo. They have very different rate limits (these are limitations in the API that `tbd` respects):
`tbd` has some neat alpha features that infer documentation and tests for your columns. There are multiple supported LLMs via API: Groq running Llama 3 70B, Anthropic Claude 3 Opus, and OpenAI GPT-4 Turbo. They have very different rate limits (these are limits in the APIs that `tbd` respects):

| Model | Requests per minute |
|----------------------------|----------------------|
Expand All @@ -147,6 +177,7 @@ I'm going to experiment very soon with using structured output conformed to dbt'

## πŸ˜… To Do

### Tier 1
- [ ] Get to 100% test coverage
- [x] Add Claude 3 Opus option
- [x] Add OpenAI GPT-4 Turbo option
Expand All @@ -160,6 +191,10 @@ I'm going to experiment very soon with using structured output conformed to dbt'
- [ ] Build on Linux
- [ ] Build on Windows

### Tier 2

- [ ] Add `tbd rerun` option, loading a previous form run from a config file in `~/.config/tbd` to 'rerun' on a different schema

## πŸ€— Contributing

I welcome Discussions, Issues, and PRs! This is pre-release software and without folks using it and opening Issues or Discussions I won't be able to find the rough edges and smooth them out. So please if you get stuck open an Issue and let's figure out how to fix it!
Expand Down

0 comments on commit 648ba23

Please sign in to comment.