Add documentation to get started

[jochemvandooren]

No description provided.

[matthieucan]

I don't think this should be in the docs

[druzhinin-kirill]

Shall we mention here a general tool purpose? Or will we introduce a separate page for this?

[jochemvandooren]

I think the general tool purpose is clear from this page

[matthieucan]

Are there other ways? :p

[druzhinin-kirill]

WDYT of pipx? Or do we intend it to be a dev dependency (so pdm/poetry example)?

[matthieucan]

This could work for some people, especially if they use dbt without a virtual environment

[matthieucan]

Which brings another point of discussion: dbt-score will pull a version of dbt, as it depends on it. Perhaps we should remove that dependency, and fail the option --run-dbt-parse if no version of dbt can be found in the user environment

[jochemvandooren]

Regarding the multiple examples, I think it's implied that installing with poetry or pipenv or whatever else will work as well? Feels a little bit redundant IMO

[jochemvandooren]

dbt-score will pull a version of dbt, as it depends on it. Perhaps we should remove that dependency, and fail the option --run-dbt-parse if no version of dbt can be found in the user environment

This is a good point, but we have to think about dbt-core version dependencies. Not sure if every version will work, because the manifest might have changed

[matthieucan]

Indeed! We can check the version at run time though, if we ditch the dependency

[jochemvandooren]

I have changed the wording a little bit, I think we can keep it simple.

[matthieucan]

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"?

[jochemvandooren]

Good idea 👍

[matthieucan]

Last comment: let's add somewhere the commands dbt-score --help and dbt-score lint --help :)