Skip to main content

Installation

Install from PyPI​

pip install briefcase-ai

For live lakeFS integrations:

pip install "briefcase-ai[lakefs]"

Python Requirements​

  • Python >=3.10 for the Rust-backed package

Canonical Import Surface​

Use briefcase_ai for all new code. Compatibility aliases are exposed directly on briefcase_ai:

  • versioned
  • lakefs_versioned
  • versioned_context
  • lakefs_context
  • briefcase_workflow

The legacy briefcase namespace still exists in 2.1.30 for compatibility and emits DeprecationWarning. It is scheduled for removal in 2.1.31.

Optional Dependencies​

Some integrations require extra provider SDKs at runtime.

Examples:

  • lakeFS client SDK (for certain lakeFS workflows)
  • Vector store SDKs (pinecone, weaviate, chromadb)
  • Framework SDKs (LangChain/LlamaIndex)

If optional dependencies are missing, compatibility shims raise actionable import/runtime errors.

Verification​

Modern namespace​

import briefcase_ai

print(briefcase_ai.__version__)

Next Steps​