Skip to main content

Integrations API

lakeFS Integration​

The lakeFS integration provides versioned data access capabilities for Briefcase AI applications.

VersionedClient​

Class: briefcase_ai.integrations.lakefs.client.VersionedClient

A client for interacting with lakeFS repositories with versioning support.

Methods​

  • __init__ - Initialize the versioned client
  • read_object - Read an object from the repository
  • list_objects - List objects in the repository
  • get_commit - Get commit information
  • object_exists - Check if an object exists
  • upload_object - Upload an object to the repository

VersionedContextManager​

Class: briefcase_ai.integrations.lakefs.context.VersionedContextManager

Context manager for handling versioned operations with automatic cleanup.

Versioned Decorator​

Function: briefcase_ai.integrations.lakefs.decorators.versioned

Decorator for adding versioning capabilities to functions.

ArtifactLineageClient​

Class: briefcase_ai.integrations.lakefs.lineage.ArtifactLineageClient

Commit-aware artifact versioning client used for workflow outputs and audit artifacts.

Key Methods​

  • from_env - Build client from LAKEFS_* environment variables
  • version_files - Upload objects and create commit
  • object_uri - Generate lakefs:// URI by branch or commit

Modes​

  • auto - use live lakeFS when reachable, otherwise simulated
  • live - require live lakeFS operations
  • simulate - deterministic local commit simulation

Workflow Modules​

BrokerDealerOnboardingWorkflow​

Class: briefcase_ai.workflows.broker_dealer_onboarding.BrokerDealerOnboardingWorkflow

Institutional onboarding workflow that emits:

  • flagged issues with rule references
  • decision memo markdown
  • lakeFS commit references for packet, analysis, and artifact publication

VCS Providers​

Python VCS integrations are exposed under briefcase_ai.integrations.vcs:

  • DvcClient
  • NessieClient
  • PachydermClient
  • ArtiVCClient
  • DuckLakeClient
  • IcebergClient
  • GitLFSClient

All provider clients inherit from VcsClientBase.

Use briefcase_ai for new code. The legacy briefcase alias is scheduled for removal in 2.1.31.