Orbex Connect Python SDK

Connect to Orbex Buckets using simple client and resource APIs.

python -m pip install -e sdks/python-orbex-bucket
export ORBEX_API_KEY="your-64-character-api-key"

Low-level client:

import orbex_connect

orbex = orbex_connect.client()
orbex.create_bucket(Bucket="analytics-data")
orbex.upload_file("orders.csv", "analytics-data", "incoming/orders.csv")

response = orbex.get_object(Bucket="analytics-data", Key="incoming/orders.csv")
data = response["Body"].read()

for item in orbex.list_objects_v2(Bucket="analytics-data", Prefix="incoming/")["Contents"]:
    print(item["Key"], item["Size"])

orbex.download_file("analytics-data", "incoming/orders.csv", "downloaded.csv")
orbex.delete_object(Bucket="analytics-data", Key="incoming/orders.csv")

Resource API:

orbex = orbex_connect.resource()
bucket = orbex.Bucket("analytics-data")
bucket.put_object(Key="reports/summary.json", Body='{"status":"ready"}', ContentType="application/json")

for obj in bucket.objects.filter(Prefix="reports/"):
    print(obj.key, obj.size)

Supported client methods include list_buckets, create_bucket, delete_bucket, head_bucket, put_object, get_object, head_object, delete_object, delete_objects, copy_object, list_objects_v2, upload_file, upload_fileobj, download_file, download_fileobj, and get_paginator.

For local development pass base_url="http://localhost:3000" to orbex_connect.client() or set ORBEX_ENDPOINT_URL.

Managed Genorbex notebooks can use the injected ORBEX_API_TOKEN and ORBEX_API_URL variables automatically; no credentials need to appear in code.