Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Openlineage Prefect

Basic Configuration

At a minimum, define a namespace, Prefect API URL and transport consisting of a type, URL and endpoint. All three can be supplied using environment variables.

For example:

export OPENLINEAGE_NAMESPACE='prefect_test' &&
export OPENLINEAGE__TRANSPORT__TYPE='http' &&
export OPENLINEAGE__TRANSPORT__URL='http://lineageconsumer.com:5000' &&
export OPENLINEAGE__TRANSPORT__ENDPOINT='/api/v1/lineage' &&
export PREFECT_API_URL='http://prefecthost.com:4200/api'

For more details about OpenLineage transport options and how to configure them, consult the OpenLineage Python Client Documentation.

Execution

Import the openlineage_prefect package and execute collect_and_process_runs() asynchronously in its own process.

For example:

import asyncio
import openlineage_prefect
from openlineage_prefect.prefect_adapter.listener import PrefectOpenLineageListener

async def main():
    await PrefectOpenLineageListener().collect_and_process_runs()

if __name__ == "__main__":
    asyncio.run(main())

Datasets

The integration looks for datasets in Prefect Artifacts. To attach input and output datasets to job runs, use create_table_artifact() from the Artifact library. Provide a namespace, typically the dataset URI, and name to the adapter via an artifact's table and description, respectively. Distinguish the type of dataset by appending _output or _input to the description.

For example:

ol_table = [{"database_uri":"duckdb:///customers_db", "table":"customers"}]

create_table_artifact(
    key="upstream-insert",
    table=ol_table,
    description="ol-dataset_output"
)

Metadata

Release files for openlineage-prefect 0.0.1b5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openlineage-prefect 0.0.1b5
File Size Uploaded
openlineage_prefect-0.0.1b5.tar.gz 6.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for openlineage-prefect 0.0.1b5
File Interpreter ABI Platform
openlineage_prefect-0.0.1b5-py3-none-any.whl Python 3 none any Details

Total release size: 16.3 kB

Release files / openlineage_prefect-0.0.1b5.tar.gz

Download URL openlineage_prefect-0.0.1b5.tar.gz
Size 6.8 kB
Tags Source
SHA-256 checksum
How to use checksums
9225a5f6ddfb6fe7f1469c37c69f8afba7b5b0bc8d08a20e6f71ef961655f10f
BLAKE2b-256 checksum
How to use checksums
8ecd852fa88ebeb9db582bc8a378858c6e7035810d4cca9692779f82bd9fc875
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / openlineage_prefect-0.0.1b5-py3-none-any.whl

Download URL openlineage_prefect-0.0.1b5-py3-none-any.whl
Size 9.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7c103633f6463d0de20eab4bc0fb285b32601e2c3ef23e9da34fc9ba44b53980
BLAKE2b-256 checksum
How to use checksums
b19e30ea0e29fe60d285cd57dceb52fe2f12ce8c1875f17409bf54693546af46
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page