lakeFS Python SDK Wrapper
Project description
lakeFS Python SDK (Pre-release Beta)
lakeFS Software Development Kit (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
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
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
lakefs-0.1.0b1.tar.gz
(24.8 kB
view hashes)
Built Distribution
lakefs-0.1.0b1-py3-none-any.whl
(32.5 kB
view hashes)