Skip to main content

Dbt Core Interface

Project description

Dbt Core Interface

PyPI Status Python Version License

Read the documentation at https://dbt-core-interface.readthedocs.io/ Tests

pre-commit Black

Features

An extremely simplified interface is provided to accomplish all of the following with no dependencies outside dbt-core:

  • Parse dbt project on disk loading dbt core classes into memory from a single class/interface

  • Automatic management of the adapter and thread-safe efficient connection pool reuse

  • Run SQL and get results in python fully independent of the dbt adapter which automatically enables support for many databases

  • Run SQL with dbt SQL from a single method call

  • Load macros at runtime enabling custom functionality in third party extensions without requiring the dbt packaging system to be managed in userland

  • Compile dbt jinja extremely fast and efficiently, thread-safe and stress tested at load via a fastapi server which live compiles SQL

  • Manage multiple dbt projects in a single process using the DbtProjectContainer class

dbt-core-interface is a wrapper that allows developers to rapidly develop features and integrations for dbt. This project aims to serve as a place for the community to aggregate the best ways to interface with dbt. It is afforded a much faster iteration cycle and much more freedom due to it's independence from the dbt codebase. It is intended to act as an common library to dbt's existing APIs for developers. Implementations can land here and prove themselves out before landing in the dbt-core codebase and benefit all developers involved. Sqlfluff dbt templater, dbt-osmosis, dbt-fastapi which I am ripping out of dbt-osmosis, an impending metadata manager, a testing framework will all leverage this library. As dbt core evolves and stabilizes its python API, this project will evolve with it. This may manifest in simplification of certain methods but our goal is to maintain the API and focus on driving efficient, innovative/creative, and agile community driven integration patterns.

Requirements

  • The only requirement is dbt-core, tested with versions 1.0.*, 1.1.*, 1.2.*, 1.3.*

Installation

You can install Dbt Core Interface via pip from PyPI:

$ pip install dbt-core-interface

Usage

Please see the Api Reference for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Dbt Core Interface is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dbt_core_interface-0.2.3.tar.gz (69.8 kB view details)

Uploaded Source

Built Distribution

dbt_core_interface-0.2.3-py3-none-any.whl (68.5 kB view details)

Uploaded Python 3

File details

Details for the file dbt_core_interface-0.2.3.tar.gz.

File metadata

  • Download URL: dbt_core_interface-0.2.3.tar.gz
  • Upload date:
  • Size: 69.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for dbt_core_interface-0.2.3.tar.gz
Algorithm Hash digest
SHA256 ef35d50e0b57602609066be25a52a0ff7343f4b33881b9674756f0ba84a6c88d
MD5 aed49ad1eb25c488af3221e34cc2d25c
BLAKE2b-256 2d74da09b8ad9aba094dd7fab0246294f2203c7066a79bdbfcfac1c88a510162

See more details on using hashes here.

File details

Details for the file dbt_core_interface-0.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for dbt_core_interface-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b51822ad00d6622bd66777a868021271eba4feb2064de6068a337e0908eebbcc
MD5 e13a16bd96bb567cda572cff7d588a39
BLAKE2b-256 bc0ae8e713c5d85b0c2d13027e5cded9c7f6cedb7aa77737180971df08d378d9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page