Skip to main content
Pre-release

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

lakeFS Python SDK (Pre-release Beta)

lakeFS Software Development Kit (SDK) for Python, provides developers with the following features:

  1. Simpler programming interface with less configuration
  2. Inferring identity from environment
  3. Better abstractions for common, more complex operations (I/O, transactions, imports)

Requirements.

Python 3.9+

Installation & Usage

pip install

pip install lakefs

Then import the package:

import lakefs

Getting Started

Please follow the installation procedure and then run the following:

import lakefs
from lakefs.client import Client, init

# Using default client will attempt to authenticate with lakeFS server using configured credentials
# If environment variables or .lakectl.yaml file exist 
repo = lakefs.Repository(repository_id="my-repo")

# Alternatively, provide explicit credentials and call client init method, which will initialize the default client
init(username="<lakefs_access_key_id>", password="<lakefs_secret_access_key>", host="<lakefs_endpoint>")
repo = lakefs.Repository(repository_id="my-repo")

# Or explicitly initialize and provide a Client object 
clt = Client(username="<lakefs_access_key_id>", password="<lakefs_secret_access_key>", host="<lakefs_endpoint>")
repo = lakefs.Repository(repository_id="my-repo", client=clt)

# From this point, proceed using the package according to documentation
main_branch = repo.create(storage_namespace="<storage_namespace>").branch(branch_id="main")
...

Tests

To run the tests using pytest, first clone the lakeFS git repository

git clone https://github.com/treeverse/lakeFS.git
cd lakefs/clients/python-wrapper

Unit Tests

Inside the tests folder, execute pytest utests to run the unit tests.

Integration Tests

See testing documentation for more information

Documentation

lakeFS Python SDK

Author

services@treeverse.io

Metadata

Release files for lakefs 0.1.0b2

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

Source distribution (sdist)

Source distribution for lakefs 0.1.0b2
File Size Uploaded
lakefs-0.1.0b2.tar.gz 29.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for lakefs 0.1.0b2
File Interpreter ABI Platform
lakefs-0.1.0b2-py3-none-any.whl Python 3 none any Details

Total release size: 68.4 kB

Release files / lakefs-0.1.0b2.tar.gz

Download URL lakefs-0.1.0b2.tar.gz
Size 29.4 kB
Tags Source
SHA-256 checksum
How to use checksums
f2e533cb5baf8e0bb8a6e4f49761a0fa272e254bb7e5ec737b99225e94f96e99
BLAKE2b-256 checksum
How to use checksums
32a7f58bf17a3aca4713cb2b257ef46d58b3e8f29af334ca8d7d2795e172438e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.6

Release files / lakefs-0.1.0b2-py3-none-any.whl

Download URL lakefs-0.1.0b2-py3-none-any.whl
Size 38.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
631792d54b276aa10d12af05b11691721538f7d09b2a0ad050f1ca79e89ab1f0
BLAKE2b-256 checksum
How to use checksums
b960c8fe864d02e7bfb3321b9460ec25be8d365abe04ecab41f9bb31bddd02ba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.6
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