Metadata-Version: 2.4
Name: autumn-rs
Version: 0.1.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Rust
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Database
Classifier: Topic :: System :: Distributed Computing
Summary: Python client for autumn-rs: KV (zero-copy batch reads and writes) and the fs/ tree
License-Expression: Apache-2.0
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Homepage, https://github.com/journeymidnight/autumn-rs
Project-URL: Source, https://github.com/journeymidnight/autumn-rs/tree/main/python

# autumn-rs (Python)

The Python client for [autumn-rs](https://github.com/journeymidnight/autumn-rs),
a distributed storage engine for AI data. It is a native extension (PyO3); the
import name is `autumn`.

```bash
pip install autumn-rs
```

One abi3 wheel per architecture serves every CPython >= 3.11 on Linux
(manylinux 2.28, x86_64 and aarch64). The published wheel uses TCP; RDMA (UCX)
needs a build from source with `--features ucx`.

```python
import asyncio, autumn

async def main():
    c = await autumn.Client.connect("127.0.0.1:9001", "kvc")
    await c.put(b"mykey", b"hello")
    print(await c.get(b"mykey"))

asyncio.run(main())
```

- `autumn.Client`: async KV (`put`, `get`, `delete`, `range`, `head`, batches).
- `autumn.BatchClient`: blocking batched reads and writes straight into your
  buffers, with the GIL released. This is what the KV-cache adapters use.
- `autumn.Fs`: the same `fs/` tree the FUSE mount and the S3 gateway serve,
  without a mount.

A namespace must exist before it serves keys, and a cluster with authorization
on needs `principal=` and `credential=` on connect. See the autumn-rs
[README](https://github.com/journeymidnight/autumn-rs#readme) and `docs/ops.md`.

Build from source, in this directory:

```bash
maturin build --release --features abi3   # one wheel for CPython >= 3.11
maturin build --release              # bound to this interpreter, any CPython >= 3.8
maturin build --release --features ucx --auditwheel skip   # links the system UCX
```

License: Apache-2.0.

