Use Python to interact with lakeFS¶
Warning
If your project is currently using the legacy Python lakefs-client, please be aware that this version has been deprecated.
As of release v1.44.0, it's no longer supported for new updates or features.
Getting Started¶
New to lakeFS Python SDK? Start with the High-Level SDK Guide to install and configure the recommended Python package.
The High-Level SDK provides an intuitive interface for:
- Branches & Merging - Feature branch workflows
- References, Commits & Tags - References, Commits & Tags
- Transactions - Atomic operations
- Data Operations - Batch operations and cleanup
Integration Options¶
lakeFS provides multiple Python packages to suit different use cases and preferences:
| Package | Abstraction | Best For | Installation | Learning Curve |
|---|---|---|---|---|
| High-Level SDK | High | Versioning operations, data operations, transactions | pip install lakefs |
Low |
| Generated SDK | Low | Direct API access, full API surface, programmatic control | pip install lakefs-sdk |
Medium |
| lakefs-spec | High | File system operations, pandas/data science integration, S3-like interface | pip install lakefs-spec |
Low |
| Boto / S3 Gateway | Medium | S3-compatible operations, existing S3 workflows, direct gateway access | pip install boto3 |
Low |
References & Resources¶
- High Level Python SDK Documentation: https://pydocs-lakefs.lakefs.io
- Generated Python SDK Documentation: https://pydocs-sdk.lakefs.io
- lakefs-spec Project: https://lakefs-spec.org
- Boto S3 Router: https://github.com/treeverse/boto-s3-router