Skip to main content
Pre-release

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

lakeFS High-Level Python SDK (Pre-release Beta)

lakeFS High Level 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

Import the package

import lakefs

Getting Started

Please follow the installation procedure and afterward refer to the following example snippet for a quick start:

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.0b3

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.0b3
File Size Uploaded
lakefs-0.1.0b3.tar.gz 31.5 kB Details

Built distribution (wheel)

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

Total release size: 72.7 kB

Release files / lakefs-0.1.0b3.tar.gz

Download URL lakefs-0.1.0b3.tar.gz
Size 31.5 kB
Tags Source
SHA-256 checksum
How to use checksums
1b4191d460ecde519d737a6c464e67f288cb50a23852d371be0b109fc5f73cb9
BLAKE2b-256 checksum
How to use checksums
fc49380bb30a854382dac376060ad44d1cdc3dff0d36e08e351d7e3caee57de5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.7

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

Download URL lakefs-0.1.0b3-py3-none-any.whl
Size 41.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e57b94dc621d4af9e09c4e619136e00664b6d519dfa3ff0e09fb61b8efb21ccd
BLAKE2b-256 checksum
How to use checksums
48fd854db048ec5c43877ba604b45f11576d746452e6a81b96f6f604880eeaf0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.7
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