Metadata-Version: 2.4
Name: hanzo-s3
Version: 1.0.0
Summary: Hanzo S3 — Python client for S3-compatible object storage
Project-URL: Homepage, https://hanzo.space
Project-URL: Documentation, https://docs.hanzo.ai/s3
Project-URL: Repository, https://github.com/hanzos3/py-sdk
Project-URL: Source, https://github.com/hanzoai/python-sdk
Author-email: Hanzo AI <dev@hanzo.ai>
License: Apache-2.0
Keywords: cloud-storage,hanzo,minio,object-storage,s3
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.9
Requires-Dist: minio>=7.2.0
Provides-Extra: dev
Requires-Dist: mypy>=1.10.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Requires-Dist: ruff>=0.5.0; extra == 'dev'
Description-Content-Type: text/markdown

# hanzo-s3

Hanzo S3 -- Python client for S3-compatible object storage.

Thin wrapper around the [minio](https://pypi.org/project/minio/) package that
re-exports its public API under the `hanzo_s3` namespace with Hanzo-flavoured
aliases.

## Install

```bash
pip install hanzo-s3
# or
uv add hanzo-s3
```

## Quick start

```python
from hanzo_s3 import S3Client

client = S3Client(
    "s3.hanzo.space",
    access_key="YOUR-ACCESS-KEY",
    secret_key="YOUR-SECRET-KEY",
)

# List buckets
for bucket in client.list_buckets():
    print(bucket.name, bucket.creation_date)

# Upload a file
client.fput_object("my-bucket", "remote/path.txt", "/local/path.txt")

# Download a file
client.fget_object("my-bucket", "remote/path.txt", "/local/download.txt")
```

## Admin operations

```python
from hanzo_s3.admin import S3Admin

admin = S3Admin("s3.hanzo.space", credentials=provider)
info = admin.info()
```

## API

| hanzo_s3 | minio |
|----------|-------|
| `S3Client` / `Client` | `Minio` |
| `S3Admin` / `Admin` | `MinioAdmin` |
| `S3Error` / `Error` | `S3Error` |
| `S3Exception` | `MinioException` |
| `S3AdminException` | `MinioAdminException` |

All original `minio` names are also re-exported for backward compatibility.

## Links

- Documentation: https://docs.hanzo.ai/s3
- Hanzo Space: https://hanzo.space
- Source (upstream): https://github.com/hanzos3/py-sdk
- Source (SDK): https://github.com/hanzoai/python-sdk
