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

Register tasman-identity-graph package #328

Merged
merged 1 commit into from
Oct 18, 2024

Conversation

alkm1g12
Copy link
Contributor

@alkm1g12 alkm1g12 commented Oct 3, 2024

Description

Tell us about your new package!
Identity resolution (sometimes referred to as 'identity stitching' or 'identity backstitching') is the process by which multiple user identities are unified into a single profile. It is a critical step in the tracking process to ensure accurate measurement of user behaviour across multiple apps or sessions, and the creation of a single customer view. We have implemented a connected component algorithm in SQL to take a set of identifying events and translate them into a user identity table.

Link to your package's repository: https://github.com/TasmanAnalytics/tasman-identity-graph/blob/main/README.md

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() }}.
  • 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)

@dbeatty10
Copy link
Contributor

Very cool @alkm1g12 🤩 !

Is this ready for review? Or are you not ready yet?

@alkm1g12 alkm1g12 marked this pull request as ready for review October 18, 2024 13:37
@alkm1g12
Copy link
Contributor Author

Hi @dbeatty10,
Sorry I got distracted and needed to add a few tweaks based on some internal feedback to match the requirements of pushing a package to dbt! I've done that now so it should be good to go! 👍

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.

Very cool @alkm1g12 🤩

@dbeatty10 dbeatty10 merged commit 9a77764 into dbt-labs:main Oct 18, 2024
3 checks passed
@alkm1g12
Copy link
Contributor Author

@dbeatty10 i've noticed that from this merge we now have tasman_dbt_package and tasman_identity_graph both pointing to the id graph repo from the dbt package hub, any ideas how to get that tasman_dbt_package one removed?

@dbeatty10
Copy link
Contributor

@alkm1g12 Ah, I see the first part of the fix you did in TasmanAnalytics/tasman-identity-graph#7.

To do the second part and remove an old package name from the hub homepage, open a PR within the dbt-labs/hub.getdbt.com repo that adds it to blocklist.json.

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