Avatar Python Client

Requirements

The avatars package requires Python 3.12 or above.

Tutorials

The tutorials are available in 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.)

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

pip install octopize.avatar

or, if you're using uv

uv add octopize.avatar

or, if you're using poetry

poetry add octopize.avatar

License

This software is made available through the Apache License 2.0.

Contact

help@octopize.io

Releasing

See internal docs.