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

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

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

Built distribution (wheel)

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

Total release size: 72.7 kB

Release files / lakefs-0.1.0b4.tar.gz

Download URL lakefs-0.1.0b4.tar.gz
Size 31.5 kB
Tags Source
SHA-256 checksum
How to use checksums
37750df623bc44bf78bbd2da9fbca80239b1bb589c937895efbe1ce9b5ef0602
BLAKE2b-256 checksum
How to use checksums
911bbb2acd9e9f449149c3e13295ef74cdeb42467a751b87d95437ca908d3b38
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.0b4-py3-none-any.whl

Download URL lakefs-0.1.0b4-py3-none-any.whl
Size 41.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2780b8a7cb227186fde831dcfc268f611ee3d90b8c59888d42e83b6ecdd549dd
BLAKE2b-256 checksum
How to use checksums
84463d9b1c44723c368c0c21bbb1515eaa85c5bc0f2c2d503d496c67de4d8994
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