# DiceBear PIP CLI
[](https://pepy.tech/project/dicebear) [](https://pepy.tech/project/dicebear) \
[`dicebear`](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 API wrapper: https://pypi.org/project/dicebear/
* Dicebear pip CLI: https://pypi.org/project/dicebear-cli/
* 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 `py -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://avatars.dicebear.com/styles
* `adventurer`
* `adventurer-neutral`
* `avataaars`
* `big-ears`
* `big-ears-neutral`
* `big-smile`
* `bottts`
* `croodles`
* `croodles-neutral`
* `identicon`
* `initials`
* `micah`
* `miniavs`
* `open-peeps`
* `personas`
* `pixel-art`
* `pixel-art-neutral`
### Formats
These are the only supported formats.
* `png`
* `svg`
---
## 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 that helped
making avatars!
## Licenses and privacy policy
- Dicebear **Licenses**: https://avatars.dicebear.com/licenses
- Dicebear **Privacy Policy**: https://avatars.dicebear.com/legal/privacy-policy
- Dicebear Python CLI (this project): https://github.com/jvherck/dicebear/blob/main/LICENSE
Raw data
{
"_id": null,
"home_page": "https://github.com/jvherck/dicebear-cli",
"name": "dicebear-cli",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,dicebear,avatar,generating,API,wrapper,image,svg,png,cli",
"author": "jvherck",
"author_email": "<contact@janvh.tk>",
"download_url": "https://files.pythonhosted.org/packages/a0/78/b9b7cc21dff712479e9a8515703a70ce74aa7c784d4ea38bc901209f8005/dicebear-cli-1.0.2.tar.gz",
"platform": null,
"description": "# DiceBear PIP CLI\r\n[](https://pepy.tech/project/dicebear) [](https://pepy.tech/project/dicebear) \\\r\n[`dicebear`](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## Useful links\r\n* Dicebear API wrapper: https://pypi.org/project/dicebear/\r\n* Dicebear pip CLI: https://pypi.org/project/dicebear-cli/\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## How to install\r\nRun `pip install dicebear-cli`\\\r\nIf that doesn't work try `py -m pip install dicebear-cli`\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### Styles\r\nAll the possible avatar styles. \\\r\nhttps://avatars.dicebear.com/styles\r\n\r\n* `adventurer`\r\n* `adventurer-neutral`\r\n* `avataaars`\r\n* `big-ears`\r\n* `big-ears-neutral`\r\n* `big-smile`\r\n* `bottts`\r\n* `croodles`\r\n* `croodles-neutral`\r\n* `identicon`\r\n* `initials`\r\n* `micah`\r\n* `miniavs`\r\n* `open-peeps`\r\n* `personas`\r\n* `pixel-art`\r\n* `pixel-art-neutral`\r\n\r\n\r\n### Formats \r\nThese are the only supported formats.\r\n\r\n* `png`\r\n* `svg`\r\n\r\n---\r\n\r\n## Credits\r\nSpecial thanks to [DiceBear](https://github.com/dicebear) \r\n([Florian K\u00f6rner](https://github.com/FlorianKoerner)) \r\nfor making this amazing API and to all artists that helped \r\nmaking avatars!\r\n\r\n## Licenses and privacy policy\r\n- Dicebear **Licenses**: https://avatars.dicebear.com/licenses\r\n- Dicebear **Privacy Policy**: https://avatars.dicebear.com/legal/privacy-policy\r\n- Dicebear Python CLI (this project): https://github.com/jvherck/dicebear/blob/main/LICENSE\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A python CLI for DiceBear's avatar generating API.",
"version": "1.0.2",
"split_keywords": [
"python",
"dicebear",
"avatar",
"generating",
"api",
"wrapper",
"image",
"svg",
"png",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9ae443c4f823b1def577a295a3b948e2f5fef7b301e7cf3eb6646913dcd5e882",
"md5": "b5db12a64cdfc6b9245525494531a280",
"sha256": "99a84b5fb102a31c459637553498760fcd7d18c80af5aa157ccd78cf8e012fc3"
},
"downloads": -1,
"filename": "dicebear_cli-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b5db12a64cdfc6b9245525494531a280",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5966,
"upload_time": "2023-01-24T15:49:29",
"upload_time_iso_8601": "2023-01-24T15:49:29.283262Z",
"url": "https://files.pythonhosted.org/packages/9a/e4/43c4f823b1def577a295a3b948e2f5fef7b301e7cf3eb6646913dcd5e882/dicebear_cli-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a078b9b7cc21dff712479e9a8515703a70ce74aa7c784d4ea38bc901209f8005",
"md5": "f7d5eefb17f9101d5bffdb07182117d4",
"sha256": "98c3f96b57b0e6d44e1a1a2ee39d3b0c9f06e2755edf06c7d50aafc277d44fc7"
},
"downloads": -1,
"filename": "dicebear-cli-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "f7d5eefb17f9101d5bffdb07182117d4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4478,
"upload_time": "2023-01-24T15:49:31",
"upload_time_iso_8601": "2023-01-24T15:49:31.477136Z",
"url": "https://files.pythonhosted.org/packages/a0/78/b9b7cc21dff712479e9a8515703a70ce74aa7c784d4ea38bc901209f8005/dicebear-cli-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-24 15:49:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "jvherck",
"github_project": "dicebear-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "dicebear-cli"
}
JSON
