-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation to get started #25
Merged
jochemvandooren
merged 7 commits into
master
from
jvandooren/getting-started-documentation
May 27, 2024
Merged
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
674b0bb
Add section to get started
jochemvandooren eb56c51
Improve wording
jochemvandooren 3c9e418
Remove dependency documentation
jochemvandooren 71b1c4a
Change wording
jochemvandooren 1a34d6f
Add sentence about virtual environments
jochemvandooren 3c2e303
Add --help commands
jochemvandooren d7eed86
Merge branch 'master' into jvandooren/getting-started-documentation
jochemvandooren File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,41 @@ | ||
# 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 | ||
``` |
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we add a note here about virtual environments? Something like "if you use a virtual environment for dbt, dbt -score should be installed in the same"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea 👍