Skip to content

octopize/avatar-python

Repository files navigation

Avatar Python Client

Documentation

Documentation is available here: https://python.docs.octopize.io/

Requirements

The avatars package requires Python 3.9 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 make software installed. This may not be the case for Windows by default.)

make notebook

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

Installation

See our documentation for installation instructions.

License

This software is made available through the Apache License 2.0.

Contact

help@octopize.io

Releasing

See internal docs.