Metadata-Version: 2.1
Name: flareio
Version: 0.1.20
Summary: 
Home-page: https://github.com/Flared/python-flareio
License: MIT
Keywords: flare,sdk
Author: Alexandre Viau
Author-email: alexandre.viau@flare.io
Requires-Python: >=3.8
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
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: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Dist: mypy[dev] (>=1.11.1,<2.0.0)
Requires-Dist: requests (>=2)
Requires-Dist: requests-mock[dev] (>=1.12.1,<2.0.0)
Requires-Dist: types-requests[dev] (>=2.32.0.20240712,<3.0.0.0)
Project-URL: Repository, https://github.com/Flared/python-flareio
Description-Content-Type: text/markdown

# python-flareio

`flareio` is a light [Flare API](https://api.docs.flare.io/) SDK that wraps [requests](https://requests.readthedocs.io/) and automatically manages authentication.

Usage examples and use cases are documented in the [Flare API documentation](https://api.docs.flare.io/sdk/python).

## Installing

`flareio` is [available on PyPI](https://pypi.org/project/flareio/).

The library can be installed via `pip install flareio`.

## Basic Usage

```python
import os

from flareio import FlareApiClient


client = FlareApiClient(
    api_key=os.environ.get("FLARE_API_KEY"),
)

result = client.get(
    "/tokens/test",
).json()

print(result)
```

## Contributing

- `make test` will run tests
- `make format` format will format the code
- `make lint` will run typechecking + linting

