Skip to main content

Python client for Octopize's avatar API

Project description

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 notebook dependencies exported to a local requirements-tutorial.txt file. That file is generated locally and is not committed to the repository.

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, first export the tutorial requirements file:

uv export --only-group notebook -o requirements-tutorial.txt

Then 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

octopize_avatar-1.24.0.tar.gz (6.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

octopize_avatar-1.24.0-py3-none-any.whl (85.4 kB view details)

Uploaded Python 3

File details

Details for the file octopize_avatar-1.24.0.tar.gz.

File metadata

  • Download URL: octopize_avatar-1.24.0.tar.gz
  • Upload date:
  • Size: 6.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for octopize_avatar-1.24.0.tar.gz
Algorithm Hash digest
SHA256 003dceb13604420d645c0099f51f540695f47793caefbce1f4fbc92fe912a2e2
MD5 a52cd445101a94e156dcde99c923bfd0
BLAKE2b-256 306374ee6c2ff57c23d68ac785ddaecb16b0b94a1069dfe7057ab2efdb763226

See more details on using hashes here.

File details

Details for the file octopize_avatar-1.24.0-py3-none-any.whl.

File metadata

  • Download URL: octopize_avatar-1.24.0-py3-none-any.whl
  • Upload date:
  • Size: 85.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for octopize_avatar-1.24.0-py3-none-any.whl
Algorithm Hash digest
SHA256 674f46396b1d759561011bf703933dffd347bb735c648ce829ebaa3a606c268a
MD5 023424aabdbc77d0d932e949b2226e34
BLAKE2b-256 d172a3c7f3f5168b4c2da21acbfd05e0533ffab26ca23b2cfd290ff5accd9c36

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page