dbt-subdocs
dbt-subdocs is a python CLI you can used to generate a dbt-docs for a subset of your dbt project
🤔
Description
This project is useful if you want to generate a dbt-docs site for a subset of the models in your DBT project. By default, in dbt-docs, all your projects gets documented :
- all the models
- all the sources
- all the tests
- and all the macros
This CLI is useful if you only want to document what your end-user will be using.
This CLI simply edits the manifest.json and catalog.json used by the dbt-docs site so they do not contain nodes you don't want to display.
✨
Features
- Configure an input and output directory
- Select the models to document using tag within DBT
- Choose to exclude nodes that are useless for your users : tests, macros, seed etc...
🏃
Getting Started
Installation with pip
pip install -U dbt-subdocs
Then you can run
dbt-subdocs --help
First call to the CLI
You can call dbt-subdocs by simply using the command dbt-subdocs See all the options available using dbt-subdocs --help
Usecase 1: Only display nodes with a specific tag
Assuming your manifest.json and catalog.json are in DIRECTORY, simply call
cd DIRECTORY
dbt-subdocs --tag finance
If you want to select nodes with tags finance OR engineering, simply call
dbt-subdocs --tag finance --tag engineering
Usecase 2: Removing macros from the docs
If you want to remove macros from the manifest.json you can call
dbt-subdocs --tag finance --exclude-node-type macros
You can also remove sources by using
dbt-subdocs --tag finance --exclude-node-type macros --exclude-node-type sources
🛡️
License
This project is licensed under the terms of the MIT license. See LICENSE for more details.
📃
Citation
@misc{dbt-subdocs,
author = {jb-delafosse},
title = {dbt-subdocs is a python CLI you can used to generate a dbt-docs for a subset of your dbt project},
year = {2022},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/jb-delafosse/dbt-subdocs}}
}
Credits 
This project was generated with python-package-template
1 Jan 17, 2022
102 Dec 14, 2022
4.8k Dec 30, 2022
2 Dec 10, 2021
2 Apr 4, 2022
3 Jun 30, 2021
1 Nov 5, 2021
1 Feb 5, 2022
15 Sep 16, 2022
11 Feb 11, 2022
2 Jan 11, 2022
16 May 29, 2022
14 Sep 11, 2022
4 Aug 4, 2022
166 Dec 30, 2022
184 Jan 7, 2023
5 Nov 18, 2022
1 Jan 19, 2022
1 Feb 2, 2022