  
   
{% hint style="info" %}
Dicebear's Python package is up-to-date with Dicebear's API!
{% endhint %}
{% hint style="warning" %}
Always make sure to update to the latest version to avoid experiencing unresolved bugs!
{% endhint %}
## Introduction
[`dicebear`](https://pypi.org/project/dicebear/) is an API wrapper for . Using this wrapper you can get custom avatars for your program.\
For an example go to [`examples/dicebear.py`](https://github.com/jvherck/dicebear/tree/main/examples).
## Other languages
If you want to use Dicebear avatars but don't use Python, you can use the [dicebear Golang package](https://github.com/jvherck/dicebear-go) or the [official JS/TS package](https://github.com/dicebear/dicebear).
## Useful links
* Official Dicebear:
* PyPI:
* Docs:
* GitHub:
* Dicebear Python CLI:
* Golang package:
* JS/TS library:
## How to install
Run `pip install -U dicebear`\
If that doesn't work try `py -m pip install -U dicebear` If that still does not work, try replacing `py` with `python` or `python3`
## Usage
Important note: *Pillow* is not a required dependency, it's only required when you want to be able to edit the avatar images (using [`DAvatar.pillow()`](https://dicebear.vhjan.me/reference/avatar#def-pillow)). When using a `PIL` function while it's not installed it will raise [`dicebear.errors.PILError`](https://dicebear.vhjan.me/reference/errors#class-pilerror-imageerror).
When the environment variable `ENABLE_PYTHON_DICEBEAR_USAGE_STATS` is set to true, an API will be pinged on most function calls to update this package's usage stats. This will be used to analyse Dicebear's usage and improve your overall experience, but may have performance costs.
```python
import PIL.Image
import os
from dicebear import DAvatar, DStyle, DOptions, DColor, DFormat, bulk_create
# Enable anonymous usage statistics
os.environ['ENABLE_PYTHON_DICEBEAR_USAGE_STATS'] = 'true'
# Creating options
options = DOptions(
backgroundColor=DColor("00ddd0"),
rotate=90
)
# Making a DAvatar object
av = DAvatar(
style=DStyle.pixel_art,
seed="John Apple",
options=options
)
print(av.url_svg) # Prints the svg url
# Editing the DAvatar object
av.edit(
extra_options=DOptions(backgroundColor=DColor("000000"))
)
# Using `extra_options` keep the `rotate` option but override the `backgroundColor` option
print(av.url_webp) # Prints the webp url
# Editing the style specific customisations
av.customise(
blank_options={
"face": "variant04"
}
)
# Using `blank_options` will delete your previous customisations for this DAvatar and generate new ones
print(av.url_png) # Prints the png url
# Saving an avatar to your device
av.save(
location=None, # Passing `None` will save it in the current working directory
file_name="dicebear_avatar",
file_format=DFormat.svg,
overwrite=True,
open_after_save=False
)
# Converting the DAvatar object into a PIL.Image.Image object
av_img: PIL.Image.Image = av.pillow()
# Opening and viewing the DAvatar image
av.open(use_pil=True) # or av.view()
# Creating multiple random avatars of the same style at once
avatars: list = bulk_create(style=DStyle.random(), amount=10)
```
## CLI Usage
Dicebear has a CLI package that uses Python to generate avatars quickly. You can't customize each avatar, to do that you'll need to use the Python module.
To use the CLI run `pip install dicebear-cli` in a terminal. Documentation can be found here: .
## Credits
Special thanks to [DiceBear](https://github.com/dicebear) ([Florian Körner](https://github.com/FlorianKoerner)) for making this amazing API and to [all artists](https://dicebear.com/licenses) that helped making avatars!
## Licenses and privacy policy
* Dicebear **Licenses**:
* Dicebear **Privacy Policy**:
* Dicebear Python API wrapper (this project):
