Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

dbt2pdf

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

dbt2pdf

Generate a PDF document from your DBT project's documentation.

  • 0.0.9
  • PyPI
  • Socket score

Maintainers
1

Dbt2PDF

dbt2pdf

CI/CDTests Coverage Status Tests types - Mypy Ruff
PackagePyPI PyPI - Downloads PyPI - Python Version GitHub

[!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: https://dribia.github.io/dbt2pdf

Source Code: https://github.com/dribia/dbt2pdf


Installation

This project resides in the Python Package Index (PyPI), so it can easily be installed with pip:

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:

dbt2pdf --help

To view a given command usage documentation, the help flag can be used:

dbt2pdf <command> --help

Examples

dbt2pdf generate \
  --manifest-path ./manifest.json \
  --title "DBT Documentation" \
  --add-author john@example.com \
  --add-author doe@example.com \
  output.pdf

Contributing

Poetry is the best way to interact with this project, to install it, follow the official Poetry installation guide.

With poetry installed, one can install the project dependencies with:

poetry install

Then, to run the project unit tests:

make test-unit

To run the linters (ruff and mypy):

make lint

To apply all code formatting:

make format

License

dbt2pdf is distributed under the terms of the MIT license. Check the LICENSE file for further details.

Keywords

FAQs


Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc