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

Initital pass at deps README #4686

Merged
merged 4 commits into from
Feb 15, 2022
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions core/dbt/deps/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,35 @@
# Deps README

The deps module is responsible for installing dbt packages into dbt projects. A dbt pakage is a standalone dbt project with models and macros that solve a specific problem area. More specific information on dbt packages is available on the [docs site](https://docs.getdbt.com/docs/building-a-dbt-project/package-management).
emmyoop marked this conversation as resolved.
Show resolved Hide resolved


# What's a package?

See [How do I specify a package?](https://docs.getdbt.com/docs/building-a-dbt-project/package-management#how-do-i-specify-a-package) on the docs site for a detailed explination of the different types of packages supported and expected formats.


# Files

## `base.py`

Defines the base classes of `PinnedPackage` and `UnpinnedPackage`.

`downloads_directory` sets the directory packages will be downloaded to.

## `git.py`

Extends `PinnedPackage` and `UnpinnedPackage` specific to dbt packages defined with git urls.

## `local.py`

Extends `PinnedPackage` and `UnpinnedPackage` specific to dbt packages defined locally.

## `registry.py`

Extends `PinnedPackage` and `UnpinnedPackage` specific to dbt packages defined on the dbt Hub registry.

`install` has retry logic if the download or untarring process hit exceptions (see `dbt.utils._connection_exception_retry`).

## `resolver.py`

Resolves the package definition into package objects to download.