lakeFS High-Level Python SDK

lakeFS High Level SDK for Python, provides developers with the following features:

Simpler programming interface with less configuration
Inferring identity from environment
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.0

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.0
File	Size	Uploaded
lakefs-0.1.0.tar.gz	33.1 kB	Dec 10, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for lakefs 0.1.0
File	Interpreter	ABI	Platform	Reset
lakefs-0.1.0-py3-none-any.whl 42.9 kB Dec 10, 2023	Python 3	none	any	Details

Total release size: 76.0 kB

Release files / lakefs-0.1.0.tar.gz

Download URL	lakefs-0.1.0.tar.gz
Size	33.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`80c4df92aae89cc5449762dcf4e84a3543168916e960782993576b0b84758332`
BLAKE2b-256 checksum How to use checksums	`0250af9c5353505b895b90c2294a8a55b7d98f194c521805af352f0d8b8fa287`
Upload date	Dec 10, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.7`

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

Download URL	lakefs-0.1.0-py3-none-any.whl
Size	42.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`927a0a142c4058a245b49005090c3b4aa8bf52c9b225a3abefeac7d60bd02619`
BLAKE2b-256 checksum How to use checksums	`1bab77e3c7e46f9de420444a3848e5ca61b772f3146fcbcb870b9d0bb85ffdb9`
Upload date	Dec 10, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.7`