riffsdk
Python SDK for the Riff Storage API. Provides sync and async clients for storing, retrieving, and managing objects.
Installation
uv add riffsdk
# or
pip install riffsdk
Or install from a branch (for pre-release testing):
uv add git+https://github.com/databutton/riff-sdk-python.git@main
# or
pip install git+https://github.com/databutton/riff-sdk-python.git@main
Quick start
from riffsdk.storage import StorageClient
client = StorageClient()
# Upload (content type derived from the key: text/plain; charset=utf-8)
meta = client.put("hello.txt", "Hello, world!")
meta = client.put("notes.md", "# Title") # -> text/markdown; charset=utf-8
# Download
data = client.get("hello.txt")
# List
for obj in client.list("hello"):
print(f"{obj.key} ({obj.size} bytes)")
# Delete
client.delete("hello.txt")
client.close()
Async
from riffsdk.storage import AsyncStorageClient
async with AsyncStorageClient() as client:
await client.put("key", b"data", content_type="application/octet-stream")
data = await client.get("key")
Authentication
Set the RIFF_TOKEN environment variable. The SDK picks it up automatically.
API
Clients
StorageClient-- sync clientAsyncStorageClient-- async client
Both support: put, get, stat, exists, list, delete, close, and context manager usage.
Models
ObjectMeta-- metadata for a stored object (key, version, size, content_type, timestamps)UploadResult,DownloadResult-- operation resultsListPage-- paginated listingScope-- access scope (useaccount_scope(),project_scope(),session_scope())
Uploads
ResumableUpload/AsyncResumableUpload-- multipart resumable uploads for large filesStorageReader/StorageWriter-- streaming read/write
Content types
content_type is optional on put, upload_file, upload_stream, begin_upload and
create_write_stream. When omitted it is derived from the storage key's extension using a
table bundled with the SDK, so the result does not depend on the host's /etc/mime.types or the
Python version. Unknown extensions fall back to application/octet-stream.
upload_fileprefers the key's extension and falls back to the local filename's -- soupload_file("docs/notes.md", "/tmp/tmpXY123")still storestext/markdown.strpayloads passed toput()are encoded as UTF-8, and get; charset=utf-8appended when the derived type istext/*.- An explicit
content_type=is always used verbatim.
Exceptions
All exceptions inherit from StorageError:
AuthorisationErrorObjectNotFoundErrorVersionConflictErrorAlreadyExistsErrorLeaseConflictErrorUploadNotFoundErrorQuotaExceededErrorPartMismatchErrorStorageTransportError
Examples
See the examples/ directory for complete working examples:
basic_crud.py-- put, get, list, deleteasync_client.py-- async usage with asynciofile_upload_download.py-- file uploads with progressoptimistic_concurrency.py-- version-based conflict handling
Development
Requires Python 3.11+ and uv.
uv sync --dev # Install dependencies
mise run test # Run tests
mise run lint # Lint
mise run format # Format code
See AGENTS.md for full development workflow details.
1 maintainer
Metadata
1 maintainer
Release files for riffsdk 0.17.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| riffsdk-0.17.0.tar.gz | 115.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| riffsdk-0.17.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 155.5 kB
Release files / riffsdk-0.17.0.tar.gz
| Download URL | riffsdk-0.17.0.tar.gz |
|---|---|
| Size | 115.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8db0073164b553e080aa86c04d65281c9fa0344e084b81425541ce914976e4ad
|
|
BLAKE2b-256 checksum How to use checksums |
0fb6d6a10dab3d309e96483912b524408c7f83a1a9db9319a393cccb07d44628
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 24, 2026.
Transparency logRelease files / riffsdk-0.17.0-py3-none-any.whl
| Download URL | riffsdk-0.17.0-py3-none-any.whl |
|---|---|
| Size | 40.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3bddc53c9e94accfbbb952c9c5899b966d4aeb9edd223cab35bb0f253103b1be
|
|
BLAKE2b-256 checksum How to use checksums |
aa627a7bd22bd6dc9e76d20492cef9218407d0bd26a9d1830c89b996b50a0286
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 24, 2026.
Transparency log
