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

Added dbt-dlt-Shopify package #330

Merged
merged 2 commits into from
Oct 18, 2024
Merged

Added dbt-dlt-Shopify package #330

merged 2 commits into from
Oct 18, 2024

Conversation

dat-a-man
Copy link
Contributor

@dat-a-man dat-a-man commented Oct 16, 2024

Description

Tell us about your new package!
The Shopify dbt package offers data models to help you transform and analyze Shopify data .It's designed to integrate seamlessly with the dlt Shopify pipeline, which extracts and loads Shopify data into your data warehouse.

Link to your package's repository:
https://github.com/dlt-hub/dbt-dlt-shopify/

Checklist

This checklist is a cut down version of the best practices that we have identified as the package hub has grown. Although meeting these checklist items is not a prerequisite to being added to the Hub, we have found that packages which don't conform provide a worse user experience.

First run experience

  • (Required): The package includes a licence file detectable by GitHub, such as the Apache 2.0 or MIT licence.
  • The package includes a README which explains how to get started with the package and customise its behaviour
  • The README indicates which data warehouses/platforms are expected to work with this package

Customisability

  • The package uses ref or source, instead of hard-coding table references.

Packages for data transformation (delete if not relevant):

  • provide a mechanism (such as variables) to customise the location of source tables.
  • do not assume database/schema names in sources.

Dependencies

Dependencies on dbt Core

  • The package has set a supported require-dbt-version range in dbt_project.yml. Example: A package which depends on functionality added in dbt Core 1.2 should set its require-dbt-version property to [">=1.2.0", "<2.0.0"].

Dependencies on other packages defined in packages.yml:

  • Dependencies are imported from the dbt Package Hub when available, as opposed to a git installation.
  • Dependencies contain the widest possible range of supported versions, to minimise issues in dependency resolution.
  • In particular, dependencies are not pinned to a patch version unless there is a known incompatibility.

Interoperability

  • The package does not override dbt Core behaviour in such a way as to impact other dbt resources (models, tests, etc) not provided by the package.
  • [] The package uses the cross-database macros built into dbt Core where available, such as {{ dbt.except() }} and {{ dbt.type_string() }}. (It does not use macros)
  • The package disambiguates its resource names to avoid clashes with nodes that are likely to already exist in a project. For example, packages should not provide a model simply called users.

Versioning

  • (Required): The package's git tags validates against the regex defined in version.py
  • The package's version follows the guidance of Semantic Versioning 2.0.0. (Note in particular the recommendation for production-ready packages to be version 1.0.0 or above)

@dat-a-man dat-a-man changed the title Added Shopify package Added dbt-dlt-Shopify package Oct 16, 2024
Copy link
Contributor

@dbeatty10 dbeatty10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dat-a-man Looks good 👍

Non-blocking, but did you intend to include the logs and target folders? These are typically excluded from GitHub via a .gitignore file.

One other thing to note: my favorite dbt command is dbt build. It does the equivalent of dbt run and dbt test in one handy command (plus seeds and snapshots).

@dbeatty10 dbeatty10 merged commit 4d6cb53 into dbt-labs:main Oct 18, 2024
3 checks passed
@dbeatty10
Copy link
Contributor

@dat-a-man something else to note:

  • this package won't show up on the dbt Package Hub until you have at least one semantically versioned tag like these.

@dat-a-man
Copy link
Contributor Author

Thank you for the approval and merging @dbeatty10,
I've included your comments.

  • Logs and Target were not intended and so they were removed.
  • Documentation updated for dbt build
  • Tag v0.1.1 was added

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants