Giter Club home page Giter Club logo

dbt-sugar-doc's Introduction

Introduction

{% hint style="warning" %} dbt-sugar is very much under active development. Development happens on bitpicky/dbt-sugar. We absolutely would welcome any help from feature requests, discussion in issues, help with database connector testing to actual code changes! ๐Ÿค—.

Join the community on our Discord. {% endhint %}

What is dbt-sugar?

dbt-sugar is a command-line interface tool that allows users of dbt to perform tasks such as adding column and model documentation, enforce test coverage and tags (more to come) directly from the CLI across a variety of dbt projects. Check out the project roadmap if you want to know what is coming!

Here's the tool in action

dbt-sugar in action

Overview of Current Features

Documentation Task

  • document a model's description
  • document columns of a model (and propagate description across fields that are identically named, we call this "homogenise" and it is the main reason behind why we built dbt-sugar,
  • add common dbt builtin tests such as unique or not_null,
  • add tags

Audit Task

  • get a model or project level summary of the number of columns that are documented and tested.

What has recently changed?

We maintain and keep our CHANGELOG up to date on the GitHub repository. Head over there if you want to see all the changes since the last release.

dbt-sugar-doc's People

Contributors

bastienboutonnet avatar gitbook-bot avatar

Watchers

 avatar

Forkers

diegodewilde

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.