-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation to get started (#25)
- Loading branch information
1 parent
d42ae1e
commit 226cc0a
Showing
2 changed files
with
52 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Get started | ||
|
||
`dbt-score` is a Python library that is easy to install and use. The minimum | ||
required version of Python is `3.11`. | ||
|
||
## Installation | ||
|
||
Installation of `dbt-score` is simple: | ||
|
||
```shell | ||
pip install dbt-score | ||
``` | ||
|
||
If a virtual environment is used to run dbt, make sure to install `dbt-score` in | ||
the same environment. | ||
|
||
## Usage | ||
|
||
`dbt-score` uses the output of `dbt parse` (`manifest.json`) as input. | ||
Therefore, it is recommended to run `dbt-score` from the root of your dbt | ||
project. By default, it will look for `manifest.json` in dbt's `target` | ||
directory. | ||
|
||
`dbt-score` can be executed from the command line: | ||
|
||
```shell | ||
dbt-score lint | ||
``` | ||
|
||
To use a different manifest file, use the `--manifest` option: | ||
|
||
```shell | ||
dbt-score lint --manifest path/to/manifest.json | ||
``` | ||
|
||
It's also possible to automatically run `dbt parse`, to generate the | ||
`manifest.json` file: | ||
|
||
```shell | ||
dbt-score lint --run-dbt-parse | ||
``` | ||
|
||
To get more information on how to run `dbt-score`, `--help` can be used: | ||
|
||
```shell | ||
dbt-score --help | ||
``` | ||
|
||
```shell | ||
dbt-score lint --help | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters