byteship 0.1.5

Python client for the Byteship file upload API.

Byteship Python SDK

Python client for the Byteship upload API.

import os
from byteship import ByteshipClient, Visibility

client = ByteshipClient(api_key=os.environ["BYTESHIP_API_KEY"])

with open("photo.jpg", "rb") as photo:
    uploaded = client.upload(
        photo,
        filename="photo.jpg",
        content_type="image/jpeg",
        path="uploads/photo.jpg",
        visibility=Visibility.PUBLIC,
    )

print(uploaded.id, uploaded.url)

Multipart Uploads

Large uploads automatically use multipart sessions when the API selects them. You can force multipart uploads and tune concurrency when you need resumable part recording:

from byteship import UploadMethod

with open("video.mp4", "rb") as video:
    uploaded = client.upload(
        video,
        filename="video.mp4",
        content_type="video/mp4",
        path="uploads/video.mp4",
        method=UploadMethod.MULTIPART,
        multipart_concurrency=4,
    )

Multipart uploads require a seekable file object so the SDK can upload part ranges independently.

Browser Upload Tokens

token = client.create_upload_token(
    folder="avatars",
    visibility=Visibility.PUBLIC,
    max_upload_bytes=10 * 1024 * 1024,
)

print(token.upload_token.token)

Private Files

with open("contract.pdf", "rb") as document:
    private_file = client.upload(
        document,
        filename="contract.pdf",
        content_type="application/pdf",
        path="contracts/contract.pdf",
        visibility=Visibility.PRIVATE,
    )

signed_url = client.create_signed_url(
    private_file.path,
    expires_in_seconds=15 * 60,
)

print(signed_url.signed_url.url)

Image URLs

from byteship import image_srcset, image_url

src = image_url(uploaded.url, {"width": 800, "format": "webp"})
srcset = image_srcset(
    uploaded.url,
    widths=[320, 640, 960],
    transform={"fit": "cover", "height": 400, "format": "webp"},
)

Features

• upload creates an upload session, streams bytes to storage, and completes it, including multipart uploads when selected.
• upload_many uploads batches with bounded concurrency.
• create_upload_token mints scoped browser upload tokens from trusted server code.
• create_file_upload, create_upload, create_upload_part_urls, complete_path_upload, and complete_upload expose the lower-level upload lifecycle.
• get_file, create_signed_url, and delete_file cover file management and private delivery.
• image_url and image_srcset build Byteship tr transform URLs for responsive images.
• ByteshipError exposes structured API errors with code, status, and details.
• No runtime dependencies; the SDK uses the Python standard library.