Skip to main content

Create a dbt project the way Fishtown Analytics would

Project description

dbt-init

A tool to create dbt projects for consulting. dbt-init will create a project as a subdirectory within the target directory you provide it, and populate as much of the dbt project as possible

Installation & usage

  1. Install using pip install dbt-init
  2. To create a new client project run a command like following:
$ dbt-init --client jaffle_shop --warehouse snowflake --target_dir ~/clients/

You can also check the available arguments with dbt-init --help

Once you've created your project

  1. Update sample.profile.yml to contain the correct profile details for your client, excluding the actual credentials – e.g. username and password:
  • You can often pre-fill the host and database name.
  • You may want to use an alternate connection method (e.g. OAuth) and update the sample file to reflect this.
  1. Ensure that the users/groups/roles within a warehouse match the grant statements in the post-run hooks (defined in dbt_project.yml).

Building out the starter project

If you're interested in helping build out the starter project, here is a list of variables you can use – a lot of them have defaults based on the client name.

{{ project.name }}: The name of the project, as defined in `dbt_project.yml`, e.g. jaffle_shop.
{{ project.warehouse }}: The warehouse that a client is using.
{{ project.client_name }}: The name of the client, e.g. jaffle_shop.
{{ project.dir_name }}: The name of the directory this project is in, e.g. jaffle-shop-dbt.
{{ project.profile_name }}: The name of the profile used by this project, e.g. jaffle_shop.

To-do:

  • Configure a new profile as part of init process

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

dbt_init-0.2.7-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

Details for the file dbt_init-0.2.7-py3-none-any.whl.

File metadata

  • Download URL: dbt_init-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.5

File hashes

Hashes for dbt_init-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 e411cc9cea71dc2fd33422191fe22f9c6d173edeef90695b6ecec1507d7bdce7
MD5 315f2c7633475634eb3204e8a5ee5c45
BLAKE2b-256 d59042bc86b246c4829cbe28bdeaaa2a6b509738d424aae7962318ea91ea7598

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page