Metadata-Version: 2.3
Name: theblob
Version: 0.1.0
Summary: An S3-compatible object store
Author: Stefane Fermigier
Author-email: Stefane Fermigier <sf@abilian.com>
Requires-Dist: cyclopts>=5.3.3
Requires-Dist: defusedxml>=0.7.1
Requires-Dist: httptools>=0.6.4
Requires-Dist: uvicorn>=0.54.0
Requires-Dist: uvloop>=0.21.0
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# theblob

An S3-compatible object store written in Python. It starts as one command on one machine, and is designed to grow into a redundant cluster.

This is an experiment. Phase 1 (one server, one disk) is under construction.

## Quick start

```sh
uv sync
uv run theblob serve --data-dir ./data
```

The first start creates an access key and prints it once. Use it with any S3 client:

```python
import boto3

s3 = boto3.client(
    "s3",
    endpoint_url="http://127.0.0.1:9000",
    aws_access_key_id="...",
    aws_secret_access_key="...",
    region_name="us-east-1",
)
s3.create_bucket(Bucket="my-bucket")
s3.put_object(Bucket="my-bucket", Key="hello.txt", Body=b"hello")
```

Other commands: `theblob key create|list|delete` and `theblob fsck`. Run `theblob serve --help` for the server options, including TLS and virtual-hosted addressing.

## Development

```sh
make test      # the whole test pyramid
make lint      # ruff, ty, pyrefly, mypy
```

Tests are in `tests/`: `a_unit` for pure logic, `b_integration` for real SQLite and files, `c_e2e` for real S3 clients (boto3, AWS CLI, rclone, s5cmd) against a real server over HTTP and HTTPS. The rclone and s5cmd tests are skipped if those tools are not installed.
