Skip to main content

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

# 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")

# 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.2

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.2
File Size Uploaded
lakefs-0.1.2.tar.gz 33.3 kB Details

Built distribution (wheel)

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

Total release size: 76.5 kB

Release files / lakefs-0.1.2.tar.gz

Download URL lakefs-0.1.2.tar.gz
Size 33.3 kB
Tags Source
SHA-256 checksum
How to use checksums
32917a1f6ce418c6d383b8338e43659d6541f94896ce433b1d1aed334123e98e
BLAKE2b-256 checksum
How to use checksums
c7ad61a20453fc5149038278483dfc6c3d1e7cba0b43a77779ccb88f2ce21560
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.2-py3-none-any.whl

Download URL lakefs-0.1.2-py3-none-any.whl
Size 43.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1ae044a4ef5023c5a6b2dec72a6d2ed5eb10871c67968303db9a548a7967b68b
BLAKE2b-256 checksum
How to use checksums
c13df96d2ee8029ce669ee060ee93897ce43f0390853339b4aa688d8cd6e01c2
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