README.md

fluid-provider-sdk

Zero-dependency SDK for building FLUID data product providers.

Why a separate package?

Third-party provider authors only need the BaseProvider ABC and a handful of types. Installing the full fluid-build CLI (~40 dependencies) just to develop a provider is overkill. This SDK package has zero external dependencies.

Install

pip install fluid-provider-sdk

Quick Start

from fluid_provider_sdk import BaseProvider, ApplyResult, ProviderError

class MyCloudProvider(BaseProvider):
    name = "mycloud"

    def plan(self, contract):
        return [{"op": "create_table", "resource_id": "t1"}]

    def apply(self, actions):
        import time
        start = time.time()
        results = []
        for action in actions:
            results.append({"op": action["op"], "status": "ok"})
        return ApplyResult(
            provider=self.name,
            applied=len(results),
            failed=0,
            duration_sec=round(time.time() - start, 3),
            timestamp="",
            results=results,
        )

Register via entry point in your pyproject.toml:

[project.entry-points."fluid_build.providers"]
mycloud = "my_package.provider:MyCloudProvider"

API Reference

See the Custom Providers Guide for the full guide.