Dbt2PDF
==========================
<p align="center">
<a href="https://dribia.github.io/dbt2pdf">
<picture style="display: block; margin-left: auto; margin-right: auto; width: 40%;">
<source
media="(prefers-color-scheme: dark)"
srcset="https://dribia.github.io/dbt2pdf/img/logo_dribia_blanc_cropped.png"
>
<source
media="(prefers-color-scheme: light)"
srcset="https://dribia.github.io/dbt2pdf/img/logo_dribia_blau_cropped.png"
>
<img
alt="dbt2pdf"
src="https://dribia.github.io/dbt2pdf/img/logo_dribia_blau_cropped.png"
>
</picture>
</a>
</p>
| | |
|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| CI/CD | [](https://github.com/dribia/dbt2pdf/actions/workflows/test.yml) [](https://codecov.io/gh/dribia/dbt2pdf) [](https://github.com/dribia/dbt2pdf/actions/workflows/lint.yml) [](https://github.com/python/mypy) [](https://github.com/astral-sh/ruff) |
| Package | [](https://pypi.org/project/dbt2pdf/)   [](LICENSE) |
---
> [!CAUTION]
> This project is in early development stages and is not yet ready for production use.
> Our priority at the moment is that it works for our use case, so we are not yet focusing on
> covering all possible use cases.
---
**Documentation**: <a href="https://dribia.github.io/dbt2pdf" target="_blank">https://dribia.github.io/dbt2pdf</a>
**Source Code**: <a href="https://github.com/dribia/dbt2pdf" target="_blank">https://github.com/dribia/dbt2pdf</a>
---
## Installation
This project resides in the Python Package Index (PyPI), so it can easily be installed with `pip`:
```console
pip install dbt2pdf
```
## Usage
The `dbt2pdf` package provides a command-line interface (CLI) to convert DBT models to PDF files.
To view the avilable commands and full usage documentation, run:
```shell
dbt2pdf --help
```
To view a given command usage documentation, the help flag can be used:
```shell
dbt2pdf <command> --help
```
### Examples
```shell
dbt2pdf generate \
--manifest-path ./manifest.json \
--title "DBT Documentation" \
--add-author john@example.com \
--add-author doe@example.com \
output.pdf
```
## Contributing
[Poetry](https://python-poetry.org) is the best way to interact with this project, to install it,
follow the official [Poetry installation guide](https://python-poetry.org/docs/#installation).
With `poetry` installed, one can install the project dependencies with:
```shell
poetry install
```
Then, to run the project unit tests:
```shell
make test-unit
```
To run the linters (`ruff` and `mypy`):
```shell
make lint
```
To apply all code formatting:
```shell
make format
```
## License
`dbt2pdf` is distributed under the terms of the
[MIT](https://opensource.org/license/mit) license.
Check the [LICENSE](./LICENSE) file for further details.
Raw data
{
"_id": null,
"home_page": "https://github.com/dribia/dbt2pdf",
"name": "dbt2pdf",
"maintainer": "Dribia Code",
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": "code@dribia.com",
"keywords": "dbt, pdf, docs, documentation",
"author": "Dribia Code",
"author_email": "code@dribia.com",
"download_url": "https://files.pythonhosted.org/packages/3f/50/fd034b245db10eeba2bbc5e925cb346dd7e7322bfa167c9db3f66946cc49/dbt2pdf-0.0.8.tar.gz",
"platform": null,
"description": "Dbt2PDF\n==========================\n\n<p align=\"center\">\n <a href=\"https://dribia.github.io/dbt2pdf\">\n <picture style=\"display: block; margin-left: auto; margin-right: auto; width: 40%;\">\n <source\n media=\"(prefers-color-scheme: dark)\"\n srcset=\"https://dribia.github.io/dbt2pdf/img/logo_dribia_blanc_cropped.png\"\n >\n <source\n media=\"(prefers-color-scheme: light)\"\n srcset=\"https://dribia.github.io/dbt2pdf/img/logo_dribia_blau_cropped.png\"\n >\n <img\n alt=\"dbt2pdf\"\n src=\"https://dribia.github.io/dbt2pdf/img/logo_dribia_blau_cropped.png\"\n >\n </picture>\n </a>\n</p>\n\n| | |\n|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| CI/CD | [](https://github.com/dribia/dbt2pdf/actions/workflows/test.yml) [](https://codecov.io/gh/dribia/dbt2pdf) [](https://github.com/dribia/dbt2pdf/actions/workflows/lint.yml) [](https://github.com/python/mypy) [](https://github.com/astral-sh/ruff) |\n| Package | [](https://pypi.org/project/dbt2pdf/)   [](LICENSE) |\n---\n\n> [!CAUTION]\n> This project is in early development stages and is not yet ready for production use.\n> Our priority at the moment is that it works for our use case, so we are not yet focusing on\n> covering all possible use cases.\n\n---\n\n**Documentation**: <a href=\"https://dribia.github.io/dbt2pdf\" target=\"_blank\">https://dribia.github.io/dbt2pdf</a>\n\n**Source Code**: <a href=\"https://github.com/dribia/dbt2pdf\" target=\"_blank\">https://github.com/dribia/dbt2pdf</a>\n\n---\n\n## Installation\n\nThis project resides in the Python Package Index (PyPI), so it can easily be installed with `pip`:\n\n```console\npip install dbt2pdf\n```\n\n## Usage\n\nThe `dbt2pdf` package provides a command-line interface (CLI) to convert DBT models to PDF files.\n\nTo view the avilable commands and full usage documentation, run:\n\n```shell\ndbt2pdf --help\n```\n\nTo view a given command usage documentation, the help flag can be used:\n\n```shell\ndbt2pdf <command> --help\n```\n\n### Examples\n```shell\ndbt2pdf generate \\\n --manifest-path ./manifest.json \\\n --title \"DBT Documentation\" \\\n --add-author john@example.com \\\n --add-author doe@example.com \\\n output.pdf\n```\n\n## Contributing\n\n[Poetry](https://python-poetry.org) is the best way to interact with this project, to install it,\nfollow the official [Poetry installation guide](https://python-poetry.org/docs/#installation).\n\nWith `poetry` installed, one can install the project dependencies with:\n\n```shell\npoetry install\n```\n\nThen, to run the project unit tests:\n\n```shell\nmake test-unit\n```\n\nTo run the linters (`ruff` and `mypy`):\n\n```shell\nmake lint\n```\n\nTo apply all code formatting:\n\n```shell\nmake format\n```\n\n## License\n\n`dbt2pdf` is distributed under the terms of the\n[MIT](https://opensource.org/license/mit) license.\nCheck the [LICENSE](./LICENSE) file for further details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Generate a PDF document from your DBT project's documentation.",
"version": "0.0.8",
"project_urls": {
"Homepage": "https://github.com/dribia/dbt2pdf",
"Repository": "https://github.com/dribia/dbt2pdf"
},
"split_keywords": [
"dbt",
" pdf",
" docs",
" documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c36acbd87dcad620838b0ebb83afdb927eaf8b1b798dee3bf31542388a5b6e07",
"md5": "f611f8be0120c5b57f400704ef656380",
"sha256": "d7742c31b8b1ff6f0656c92451eea4e1b70fd3c1e14c38a54bb8a11ff47c4013"
},
"downloads": -1,
"filename": "dbt2pdf-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f611f8be0120c5b57f400704ef656380",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 12781,
"upload_time": "2024-11-07T13:23:16",
"upload_time_iso_8601": "2024-11-07T13:23:16.647800Z",
"url": "https://files.pythonhosted.org/packages/c3/6a/cbd87dcad620838b0ebb83afdb927eaf8b1b798dee3bf31542388a5b6e07/dbt2pdf-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3f50fd034b245db10eeba2bbc5e925cb346dd7e7322bfa167c9db3f66946cc49",
"md5": "d4f54065054f42c27d3d05cc16d12e4b",
"sha256": "0385d734f16e9ef4c3d1acf26c85a17b6b8a3db0e431bac6471cea88d16a38e0"
},
"downloads": -1,
"filename": "dbt2pdf-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "d4f54065054f42c27d3d05cc16d12e4b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 12081,
"upload_time": "2024-11-07T13:23:18",
"upload_time_iso_8601": "2024-11-07T13:23:18.086227Z",
"url": "https://files.pythonhosted.org/packages/3f/50/fd034b245db10eeba2bbc5e925cb346dd7e7322bfa167c9db3f66946cc49/dbt2pdf-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-07 13:23:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dribia",
"github_project": "dbt2pdf",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "dbt2pdf"
}
JSON
