Metadata-Version: 2.4
Name: filoo-sdk
Version: 0.1.0
Summary: Official Python SDK for the Filoo URL shortener API.
Project-URL: Homepage, https://filoo.app/api
Project-URL: Repository, https://github.com/jrlprost/filooapp
Author: Filoo
License: MIT
Keywords: filoo,qr-code,url-shortener
Requires-Python: >=3.9
Requires-Dist: httpx>=0.27
Description-Content-Type: text/markdown

# filoo-sdk

Official Python SDK for the [Filoo](https://filoo.app) URL shortener API.

## Install

```bash
pip install filoo-sdk
```

## Quick start

```python
from filoo import Filoo
import os

with Filoo(api_key=os.environ["FILOO_KEY"]) as filoo:
    link = filoo.links.create(
        destination="https://example.com/long-url",
        username="myname",
        slug="campaign-1",
    )
    print(link["short_url"])  # → https://filoo.app/myname/campaign-1
```

## Available methods

- `filoo.me()`
- `filoo.usage()`
- `filoo.usernames()`
- `filoo.links.create(destination, ...)`
- `filoo.links.list(limit=, cursor=)`
- `filoo.links.get(code)`
- `filoo.links.update(code, **fields)`
- `filoo.links.delete(code)`
- `filoo.links.stats(code)`

## Tier requirement

The Filoo API is available on **Pro** (€9/month, 100 req/min) and **Agents** (€29/month, 1000 req/min) plans. Get a key at [filoo.app/dashboard/api-keys](https://filoo.app/dashboard/api-keys).

## Errors

`FilooError` is raised on non-2xx responses. Check `error.status` and `error.body`.

```python
from filoo import Filoo, FilooError

try:
    filoo.links.create(destination="...")
except FilooError as e:
    if e.status == 429:
        print("Rate limited, retry later")
```

## License

MIT
