Dbt2PDF
==========================
| | |
|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 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.
## 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/d8/31/4343760df79ac902fb15b375b04660d339f3c8751d3756ae3e3e4b9ebd1f/dbt2pdf-0.0.5.tar.gz",
"platform": null,
"description": "Dbt2PDF\n==========================\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## 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.5",
"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": "8c4d422434910c0a5e5240949247d757b5cc50b1d4a1f12f4a254c96912ac840",
"md5": "14008a184286926701a368c77affff41",
"sha256": "b673189dea7eeb1cb2156b622474ce2e4a32b07b1bf976964a189766e35db15d"
},
"downloads": -1,
"filename": "dbt2pdf-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "14008a184286926701a368c77affff41",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 8978,
"upload_time": "2024-09-02T06:34:48",
"upload_time_iso_8601": "2024-09-02T06:34:48.022376Z",
"url": "https://files.pythonhosted.org/packages/8c/4d/422434910c0a5e5240949247d757b5cc50b1d4a1f12f4a254c96912ac840/dbt2pdf-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d8314343760df79ac902fb15b375b04660d339f3c8751d3756ae3e3e4b9ebd1f",
"md5": "6e51fd1648d807667926011449b7c187",
"sha256": "69320e744644877a83d9725357ae9170c338a524872c1e934edc5d6b8ccdcb07"
},
"downloads": -1,
"filename": "dbt2pdf-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "6e51fd1648d807667926011449b7c187",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 8845,
"upload_time": "2024-09-02T06:34:49",
"upload_time_iso_8601": "2024-09-02T06:34:49.469425Z",
"url": "https://files.pythonhosted.org/packages/d8/31/4343760df79ac902fb15b375b04660d339f3c8751d3756ae3e3e4b9ebd1f/dbt2pdf-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-02 06:34:49",
"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
