Skip to content

Commit

Permalink
Add documentation to get started (#25)
Browse files Browse the repository at this point in the history
  • Loading branch information
jochemvandooren authored May 27, 2024
1 parent d42ae1e commit 226cc0a
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 0 deletions.
51 changes: 51 additions & 0 deletions docs/get_started.md
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
```
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ markdown_extensions:
- pymdownx.superfences
nav:
- Home: index.md
- Get started: get_started.md
- Rules:
- rules/generic.md
- Reference:
Expand Down

0 comments on commit 226cc0a

Please sign in to comment.