Metadata-Version: 2.4
Name: octopize.avatar
Version: 1.0.5
Summary: Python client for Octopize's avatar API
Author-email: Octopize <pypi-octopize@octopize.io>
License-Expression: Apache-2.0
Requires-Python: >=3.12
Requires-Dist: fsspec>=2024.12.0
Requires-Dist: httpx>=0.28.1
Requires-Dist: octopize-avatar-yaml==0.1.15
Requires-Dist: pydantic-settings>=2.7.0
Requires-Dist: pydantic>=2.10.4
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: s3fs>=2024.12.0
Requires-Dist: structlog>=24.4.0
Requires-Dist: tenacity>=9.0.0
Requires-Dist: toolz>=1.0.0
Requires-Dist: typer>=0.15.1
Requires-Dist: types-jmespath>=1.0.2.20240106
Requires-Dist: types-seaborn>=0.13.2.20250516
Description-Content-Type: text/markdown

# Avatar Python Client

## Requirements

The `avatars` package requires Python 3.12 or above.

## Tutorials

The tutorials are available in [`notebooks/`](./notebooks) as jupyter notebooks.

To be able to run those, you must install the `avatars` package and also the dependencies in `requirements-tutorial.txt`.

We provide a helper script to setup these inside a virtual environments and run the notebooks.

Simply run the following command:

(NOTE: This assumes that you have the `just` software installed. This may not be the case for Windows by default.)

```bash
just notebook
```

If you don't have access to `just` or you want to setup the tutorial requirements manually, you can follow the installation section.

## Installation

### with pip

```bash
pip install octopize.avatar
```

### or, if you're using uv

```bash
uv add octopize.avatar
```

### or, if you're using poetry

```bash
poetry add octopize.avatar
```

## License

This software is made available through the Apache License 2.0.

## Contact

<help@octopize.io>

## Releasing

See internal docs.
