The datafold xdiff
Project description
datafold-sdk
An SDK library for the datafold application.
Installation
First, create your virtual environment for python:
> python3 -m venv venv
> source venv/bin/activate
> pip install --upgrade pip setuptools wheel
Now, you're ready to install the datafold SDK:
> pip install datafold-sdk
Datafold CLI
The datafold CLI is a utility that automates and simplifies certain tasks. Help for using this utility is available in the utility itself:
> datafold --help
Preliminary Datafold SDK
The Datafold SDK are python functions and classes that allow you to integrate these CLI functions directly in your application source code.
In the future, the SDK will contain a more type-safe and integrated "API" client library, which further facilitates integration with the datafold app server.
The only function currently implemented is the submit_artifacts
function to upload
the dbt run
artifacts to the app server:
import os
from datafold.sdk.dbt import submit_artifacts
host = os.environ.get("DATAFOLD_HOST")
api_key = os.environ.get('DATAFOLD_APIKEY')
submit_artifacts(host=host,
api_key=api_key,
ci_config_id=1,
run_type='pull_request',
target_folder='<abs-path-to-dbt-target-folder>',
commit_sha='abcdef1234567890')
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for datafold_xdiff-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0e4d458c37bad9413ac5ab6504c1efa127e14a0fbacb1fb5741e776c0db2f01 |
|
MD5 | c2c895e0fa69db696385c5a270c59068 |
|
BLAKE2b-256 | e08f5648115ab4b6896573137719ce4cfa5b83929f3ffccaa39be2df31a981dd |