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

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

Built distribution (wheel)

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

Total release size: 57.2 kB

Release files / lakefs-0.1.0b0.tar.gz

Download URL lakefs-0.1.0b0.tar.gz
Size 24.8 kB
Tags Source
SHA-256 checksum
How to use checksums
7e18a886033ad6d61e941998304a67f0d68c83dbb474a9a2f67c93e76106a89c
BLAKE2b-256 checksum
How to use checksums
fadc1e09a79aa46b54afa31b4e3f7025a727a5a65e8a479964ea88da6c6228d1
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.0b0-py3-none-any.whl

Download URL lakefs-0.1.0b0-py3-none-any.whl
Size 32.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7ff43c6ad3442056d76e396c0b77be4cb14e8a4d1df3c6b5fe5bb4ad9d9430b1
BLAKE2b-256 checksum
How to use checksums
ea613bea19db6664a7c962bf691ea13f7251d80c9ce0ba4b2916061e2bfc11c2
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