ui-avatars

Deterministic avatar URLs for light and dark designs: Gravatar or Libravatar photos falling back to colored initials via ui-avatars.com. Same input, same URL, always.

Install

pip install ui-avatars

Usage

from ui_avatars import avatar_url

avatar_url(name="Ada Lovelace", email="ada@example.com")
# Gravatar photo, falling back to generated initials

avatar_url(name="Ada Lovelace")
# straight ui-avatars.com URL, no Gravatar lookup

avatar_url(email="ada@example.com")
# initials from the first two letters of the email

avatar_url(name="Ada Lovelace", alpha=0.75, size=256, rounded=True)
# alpha, size, and ui-avatars.com rendering options as one-off overrides

avatar_url(name="Ada Lovelace", color="#dc2626")
# pick a specific color, skipping the palette

avatar_url(name="Ada Lovelace", alpha=1, background="#000")
# pin the background, let the text color rotate with the palette

avatar_url(name="Ada Lovelace", font_color="#fff")
# pin the text color, let the background rotate with the palette

avatar_url(name="Ada Lovelace", email="ada@example.com", format="png")
# force png or svg, note Gravatar errors for svg default images

avatar_url(name="Ada Lovelace", email="ada@example.com", source="libravatar")
# look up the photo on Libravatar instead of Gravatar

avatar_url(name="Ada Lovelace", email="ada@example.com", source="secure.gravatar.com")
# use a custom Gravatar-compatible photo source

avatar_url(name="Ada Lovelace", region="eu")
# use the EU ui-avatars.com endpoint for generated initials

avatar_url(name="Ada Lovelace", host="avatars.example.com")
# use a custom or self-hosted UI Avatars endpoint

Configuration

Reconfigure the shared avatars instance once, at startup, to change the palette for every call:

from ui_avatars import avatars

avatars.configure(colors=["#1d4ed8", "#b91c1c"], size=256, rounded=True)

Or build your own instance instead:

from ui_avatars import Avatars

avatars = Avatars(colors=["#1d4ed8", "#b91c1c"], size=256)
avatars.build(name="Ada Lovelace", email="ada@example.com")

The default palette is tailwind_colors's RAINBOW_500. You can swap the whole palette like so:

from tailwind_colors import TCH

avatars.configure(colors=TCH.RAINBOW_300)

For an independent background/text color instead of one tinted from the other, use a (background, text) tuple as a colors entry — alpha still applies to whichever background results:

avatars.configure(colors=[("#fee2e2", "#ef4444"), ("#ffedd5", "#f97316")])

Development

poetry install
poetry run pytest
poetry run ruff check .

License

MIT

Download files

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

Source Distribution

ui_avatars-1.2.3.tar.gz (6.1 kB view details)

Uploaded Aug 29, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

ui_avatars-1.2.3-py3-none-any.whl (6.8 kB view details)

Uploaded Aug 29, 2026 Python 3

File details

Details for the file ui_avatars-1.2.3.tar.gz.

File metadata

Download URL: ui_avatars-1.2.3.tar.gz
Upload date: Aug 29, 2026
Size: 6.1 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ui_avatars-1.2.3.tar.gz
Algorithm	Hash digest
SHA256	`f46323371fe09cfa79994ff6390a63f9c6189dc42363b3615806fb6d07f78453`
MD5	`b3ecfc8715246a9db5ebd52e6623abed`
BLAKE2b-256	`10f4b0dda7a8d4f8cf9e5dcfbb7b765898a03c1dc1059904872b1c2008f90e36`

See more details on using hashes here.

Provenance

The following attestation bundles were made for ui_avatars-1.2.3.tar.gz:

Publisher: release.yml on stevelacey/ui-avatars-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: ui_avatars-1.2.3.tar.gz
- Subject digest: f46323371fe09cfa79994ff6390a63f9c6189dc42363b3615806fb6d07f78453
- Sigstore transparency entry: 2640865318
- Sigstore integration time: Aug 29, 2026
Source repository:
- Permalink: stevelacey/ui-avatars-python@af49a61b49de388afc1ff8906922991b9fe92254
- Branch / Tag: refs/tags/1.2.3
- Owner: https://github.com/stevelacey
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@af49a61b49de388afc1ff8906922991b9fe92254
- Trigger Event: push