معرفی شرکت ها
dbt-subdocs-0.1.1
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
dbt-subdocs is a python CLI you can used to generate a dbt-docs for a subset of your dbt project
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | dbt-subdocs-0.1.1 |
| نام | dbt-subdocs |
| نسخه کتابخانه | 0.1.1 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | jb-delafosse |
| ایمیل نویسنده | hello@jb-delafosse.com |
| آدرس صفحه اصلی | https://github.com/jb-delafosse/dbt-subdocs |
| آدرس اینترنتی | https://pypi.org/project/dbt-subdocs/ |
| مجوز | MIT |
# dbt-subdocs
<div align="center">
[](https://github.com/jb-delafosse/dbt-subdocs/actions?query=workflow%3Abuild)
[](https://pypi.org/project/dbt-subdocs/)
[](https://github.com/jb-delafosse/dbt-subdocs/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)
[](https://github.com/psf/black)
[](https://github.com/PyCQA/bandit)
[](https://github.com/jb-delafosse/dbt-subdocs/blob/master/.pre-commit-config.yaml)
[](https://github.com/jb-delafosse/dbt-subdocs/releases)
[](https://github.com/jb-delafosse/dbt-subdocs/blob/master/LICENSE)
dbt-subdocs is a python CLI you can used to generate a dbt-docs for a subset of your dbt project
</div>
## 🤔 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
<details>
<summary>Installation with pip</summary>
```bash
pip install -U dbt-subdocs
```
Then you can run
```bash
dbt-subdocs --help
```
</details>
<details>
<summary>First call to the CLI</summary>
You can call dbt-subdocs by simply using the command `dbt-subdocs`
See all the options available using `dbt-subdocs --help`
</details>
<details>
<summary>Usecase 1: Only display nodes with a specific tag</summary>
Assuming your `manifest.json` and `catalog.json` are in `DIRECTORY`, simply call
```bash
cd DIRECTORY
dbt-subdocs --tag finance
```
If you want to select nodes with tags `finance` OR `engineering`, simply call
```bash
dbt-subdocs --tag finance --tag engineering
```
</details>
<details>
<summary>Usecase 2: Removing macros from the docs</summary>
If you want to remove macros from the `manifest.json` you can call
```bash
dbt-subdocs --tag finance --exclude-node-type macros
```
You can also remove sources by using
```bash
dbt-subdocs --tag finance --exclude-node-type macros --exclude-node-type sources
```
</details>
## 🛡️ License
[](https://github.com/jb-delafosse/dbt-subdocs/blob/master/LICENSE)
This project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/jb-delafosse/dbt-subdocs/blob/master/LICENSE) for more details.
## 📃 Citation
```bibtex
@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 [](https://github.com/TezRomacH/python-package-template)
This project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template)
نیازمندی
| مقدار | نام |
|---|---|
| >=0.4.0,<0.5.0 | typer[all] |
| >=10.14.0,<11.0.0 | rich |
| >=1.0.1,<2.0.0 | dbt-core |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.9,<4.0 | Python |
نحوه نصب
نصب پکیج whl dbt-subdocs-0.1.1:
pip install dbt-subdocs-0.1.1.whl
نصب پکیج tar.gz dbt-subdocs-0.1.1:
pip install dbt-subdocs-0.1.1.tar.gz