# DiceBear PIP CLI
\
[`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
Raw data
{
"_id": null,
"home_page": "https://github.com/jvherck/dicebear-cli",
"name": "dicebear-cli",
"maintainer": "jvherck",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "jan@vhjan.me",
"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",
"author": "jvherck",
"author_email": "jan@vhjan.me",
"download_url": "https://files.pythonhosted.org/packages/0f/31/5f5e014987167b687a08730b78b634c2fb5392fb1aeea30e4e89b92187f6/dicebear-cli-1.1.2.tar.gz",
"platform": null,
"description": "# DiceBear PIP CLI\r\n\r\n\r\n\r\n\r\n\r\n\r\n\\\r\n[`dicebear-cli`](https://pypi.org/project/dicebear-cli/) is a CLI for https://pypi.org/project/dicebear.\r\nUsing this CLI you can get avatars for your program (to get customised avatars use the wrapper instead).\r\n\\\r\nFor an example go to [`examples/dicebear.sh`](https://github.com/jvherck/dicebear-cli/tree/main/examples).\r\n\r\n\r\n---\r\n\r\n\r\n## Useful links\r\n* Dicebear pip CLI: https://pypi.org/project/dicebear-cli/\r\n* Dicebear API wrapper: https://pypi.org/project/dicebear/\r\n* Dicebear API wrapper GitHub: https://github.com/jvherck/dicebear\r\n* Dicebear: https://dicebear.com\r\n\r\n\r\n---\r\n\r\n\r\n## How to install\r\nRun `pip install dicebear-cli` \\\r\nIf that doesn't work try `python -m pip install dicebear-cli`\r\n\r\n\r\n---\r\n\r\n\r\n## Usage\r\nIt can quickly create one or more avatars at a time but it can't take options.\r\n\r\n```shell\r\ndicebear --help\r\n```\r\n```shell\r\ndicebear create --help\r\n```\r\n```shell\r\ndicebear create avataaars -s \"John Apple\" -f svg\r\n```\r\n\r\n\r\n---\r\n\r\n\r\n### Styles \r\nAll the possible avatar styles. \\\r\nhttps://dicebear.com/styles \r\n \r\n* `adventurer` \r\n* `adventurer-neutral` \r\n* `avataaars` \r\n* `avataaars-neutral` \r\n* `big-ears` \r\n* `big-ears-neutral` \r\n* `big-smile` \r\n* `bottts` \r\n* `bottts-neutral` \r\n* `croodles` \r\n* `croodles-neutral` \r\n* `fun-emoji` \r\n* `icons` \r\n* `identicon` \r\n* `initials` \r\n* `lorelei` \r\n* `lorelei-neutral` \r\n* `micah` \r\n* `miniavs` \r\n* `notionists`\r\n* `notionists-neutral`\r\n* `open-peeps` \r\n* `personas` \r\n* `pixel-art` \r\n* `pixel-art-neutral`\r\n* `rings`\r\n* `shapes`\r\n* `thumbs`\r\n\r\n\r\n### Formats \r\nThese are the only supported formats.\r\n\r\n* `DFormat.svg` (default) \r\n* `DFormat.png` \r\n* `DFormat.jpg` \r\n* `DFormat.json` \r\n\r\n\r\n---\r\n\r\n\r\n## Credits \r\nSpecial thanks to [DiceBear](https://github.com/dicebear) ([Florian K\u00f6rner](https://github.com/FlorianKoerner)) for \r\nmaking this amazing API and to [all artists](https://dicebear.com/licenses) for creating these avatars! \r\n\r\n\r\n## Licenses and privacy policy \r\n- Dicebear **Licenses**: https://dicebear.com/licenses \r\n- Dicebear **Privacy Policy**: https://dicebear.com/legal/privacy-policy \r\n- Dicebear Python API wrapper (this project): https://dicebear.vhjan.me/license\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A Python CLI for DiceBear's avatar generating API.",
"version": "1.1.2",
"project_urls": {
"Documentation": "https://github.com/jvherck/dicebear-cli/blob/main/README.md",
"Homepage": "https://github.com/jvherck/dicebear-cli",
"Source": "https://github.com/jvherck/dicebear-cli",
"Tracker": "https://github.com/jvherck/dicebear-cli/issues"
},
"split_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"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e2c022fb3458326a69e9a4e54ab9b7a4f7fc8dfab5ff5d04e11e4572706f3d29",
"md5": "abcd6833fd2f9864b0ffaa120a5696f5",
"sha256": "656398ba62cef9c56fa709718a317a886d20362fa1db741dd1bf077c3e126daf"
},
"downloads": -1,
"filename": "dicebear_cli-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "abcd6833fd2f9864b0ffaa120a5696f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6408,
"upload_time": "2024-05-21T22:28:38",
"upload_time_iso_8601": "2024-05-21T22:28:38.413674Z",
"url": "https://files.pythonhosted.org/packages/e2/c0/22fb3458326a69e9a4e54ab9b7a4f7fc8dfab5ff5d04e11e4572706f3d29/dicebear_cli-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f315f5e014987167b687a08730b78b634c2fb5392fb1aeea30e4e89b92187f6",
"md5": "791b4d8f7717a3e1274b35fd13b44b60",
"sha256": "223920d8342b8431b5cc0ef5f3ec73adb0fdb59bb9093e8a001408e85f2fa0f9"
},
"downloads": -1,
"filename": "dicebear-cli-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "791b4d8f7717a3e1274b35fd13b44b60",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5260,
"upload_time": "2024-05-21T22:28:40",
"upload_time_iso_8601": "2024-05-21T22:28:40.071462Z",
"url": "https://files.pythonhosted.org/packages/0f/31/5f5e014987167b687a08730b78b634c2fb5392fb1aeea30e4e89b92187f6/dicebear-cli-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-21 22:28:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jvherck",
"github_project": "dicebear-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "dicebear-cli"
}
JSON
