Skip to content
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

Improve error message in pip install dbt #4229

Closed
jtcohen6 opened this issue Nov 8, 2021 · 2 comments · Fixed by #4244
Closed

Improve error message in pip install dbt #4229

jtcohen6 opened this issue Nov 8, 2021 · 2 comments · Fixed by #4244
Labels
enhancement New feature or request

Comments

@jtcohen6
Copy link
Contributor

jtcohen6 commented Nov 8, 2021

Starting in v1.0.0, pip install dbt will raise an explicit error:

As of v1.0.0, `pip install dbt` is no longer supported.
  Instead, please use either:
    - `pip install dbt-core`, for core functionality
    - `pip install dbt-<adapter>`, to use dbt with your database, platform, or query engine
  See full list: https://docs.getdbt.com/docs/available-adapters

The goal here is clarity for what users should do as a next step. In #4133 (comment), @joellabes rightly pointed out that the first line is confusing. We expect that >95% of users will want to use the second.

Let's reorder and alter the wording in this error to something like:

As of v1.0.0, `pip install dbt` is no longer supported.
Instead, please use one of the following:

**To use dbt with your specific database, platform, or query engine:**
    
    pip install dbt-<adapter>
    
    See full list: https://docs.getdbt.com/docs/available-adapters
    
**For developers of integrations with dbt Core:**

    pip install dbt-core
    
    Be advised, dbt Core's python API is not yet stable or documented
    https://docs.getdbt.com/docs/running-a-dbt-project/dbt-api

**For the previous behavior of `pip install dbt`:**

    pip install dbt-core dbt-postgres dbt-redshift dbt-snowflake dbt-bigquery

I think we should feel comfortable taking up more screen real estate, since this is the only real thing folks will see when they run pip install dbt.

@jtcohen6 jtcohen6 added the enhancement New feature or request label Nov 8, 2021
@jtcohen6
Copy link
Contributor Author

jtcohen6 commented Nov 8, 2021

@joellabes What do you think of the proposed message above? Open to any/all wordsmithing suggestions!

@joellabes
Copy link
Contributor

Yep I'm 100% happy with this! I was originally going to suggest swapping pip install dbt-adapter to pole position, but it wouldn't have made sense with the old layout.

@jtcohen6 jtcohen6 self-assigned this Nov 8, 2021
@jtcohen6 jtcohen6 removed their assignment Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants