Metadata-Version: 2.5
Name: loonfs
Version: 0.1.0
Summary: Python client for the LoonFS HTTP API
Project-URL: Documentation, https://www.loonfs.com/docs/sdks/
Project-URL: Issues, https://github.com/loonfs/loonfs/issues
Project-URL: Repository, https://github.com/loonfs/loonfs-sdk-python
License-Expression: Apache-2.0
License-File: LICENSE
Requires-Python: >=3.8
Requires-Dist: httpx>=0.21.2
Requires-Dist: pydantic-core>=2.18.2
Requires-Dist: pydantic>=1.9.2
Requires-Dist: typing-extensions>=4.0.0
Provides-Extra: aiohttp
Requires-Dist: httpx-aiohttp>=0.1.8; extra == 'aiohttp'
Description-Content-Type: text/markdown

# LoonFS Python SDK

Typed synchronous and asynchronous clients for the LoonFS HTTP API. SDK v0.1.x
targets LoonFS API v0.3.x.

## Install

```sh
pip install loonfs
```

## Usage

```python
import os

from loonfs import LoonFS

client = LoonFS(
    base_url=os.environ["LOONFS_URL"],
    token=os.environ["LOONFS_AUTH_TOKEN"],
)

capabilities = client.system.get_capabilities()
```

`AsyncLoonFS` provides the same API for async applications. Upload and download
helpers are available from `loonfs.transfers`.

See the [generated API reference](https://github.com/loonfs/loonfs-sdk-python/blob/main/reference.md).

## Retries

The SDK retries transient failures on operations that are safe to repeat.
Operations that LoonFS classifies as non-idempotent are never retried
automatically. Use the `max_retries` client or request option to tune retries for
safe operations.

## Generated code

This SDK is generated from the LoonFS OpenAPI specification. Please report SDK
issues in the [main LoonFS repository](https://github.com/loonfs/loonfs).

## License

Apache-2.0.
