Metadata-Version: 2.1
Name: dicebear-cli
Version: 1.1.2
Summary: A Python CLI for DiceBear's avatar generating API.
Home-page: https://github.com/jvherck/dicebear-cli
Author: jvherck
Author-email: jan@vhjan.me
Maintainer: jvherck
Maintainer-email: jan@vhjan.me
License: MIT License
Project-URL: Documentation, https://github.com/jvherck/dicebear-cli/blob/main/README.md
Project-URL: Source, https://github.com/jvherck/dicebear-cli
Project-URL: Tracker, https://github.com/jvherck/dicebear-cli/issues
Keywords: python,dicebear,avatar,avatars,generating,generation,generator,API,wrapper,image,images,picture,pictures,png,jpg,svg,json,cli,pillow,pil,requests,adventurer,adventurer-neutral,avataaars,avataaars-neutral,big-ears,big-ears-neutral,big-smile,bottts,bottts-neutral,croodles,croodles-neutral,fun-emoji,icons,identicon,initials,lorelei,lorelei-neutral,micah,miniavs,notionists,notionists-neutral,open-peeps,personas,pixel-art,pixel-art-neutral,shapes,thumbs
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Other Audience
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Artistic Software
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Other/Nonlisted Topic
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# DiceBear PIP CLI
![Downloads](https://static.pepy.tech/badge/dicebear-cli)
![PyPI](https://img.shields.io/pypi/v/dicebear-cli)
![GitHub issues](https://img.shields.io/github/issues/jvherck/dicebear-cli)
![GitHub](https://img.shields.io/github/license/jvherck/dicebear-cli)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dicebear-cli)
![Maintenance](https://img.shields.io/maintenance/yes/2024)
\
[`dicebear-cli`](https://pypi.org/project/dicebear-cli/) is a CLI for https://pypi.org/project/dicebear.
Using this CLI you can get avatars for your program (to get customised avatars use the wrapper instead).
\
For an example go to [`examples/dicebear.sh`](https://github.com/jvherck/dicebear-cli/tree/main/examples).


---


## Useful links
* Dicebear pip CLI: https://pypi.org/project/dicebear-cli/
* Dicebear API wrapper: https://pypi.org/project/dicebear/
* Dicebear API wrapper GitHub: https://github.com/jvherck/dicebear
* Dicebear: https://dicebear.com


---


## How to install
Run `pip install dicebear-cli` \
If that doesn't work try `python -m pip install dicebear-cli`


---


## Usage
It can quickly create one or more avatars at a time but it can't take options.

```shell
dicebear --help
```
```shell
dicebear create --help
```
```shell
dicebear create avataaars -s "John Apple" -f svg
```


---


### Styles  
All the possible avatar styles. \
https://dicebear.com/styles  
  
* `adventurer`  
* `adventurer-neutral`  
* `avataaars`  
* `avataaars-neutral`  
* `big-ears`  
* `big-ears-neutral`  
* `big-smile`  
* `bottts`  
* `bottts-neutral`  
* `croodles`  
* `croodles-neutral`  
* `fun-emoji`  
* `icons`  
* `identicon`  
* `initials`  
* `lorelei`  
* `lorelei-neutral`  
* `micah`  
* `miniavs`  
* `notionists`
* `notionists-neutral`
* `open-peeps`  
* `personas`  
* `pixel-art`  
* `pixel-art-neutral`
* `rings`
* `shapes`
* `thumbs`


### Formats   
These are the only supported formats.

* `DFormat.svg` (default)  
* `DFormat.png`  
* `DFormat.jpg`  
* `DFormat.json`  


---


## 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) for creating these avatars!  


## Licenses and privacy policy  
- Dicebear **Licenses**: https://dicebear.com/licenses  
- Dicebear **Privacy Policy**: https://dicebear.com/legal/privacy-policy  
- Dicebear Python API wrapper (this project): https://dicebear.vhjan.me/license
