Metadata-Version: 2.1
Name: boringavatars
Version: 0.3.1
Summary: 
Author-email: Federico Bond <federicobond@gmail.com>
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: Jinja2==3.1.2
Requires-Dist: bandit[toml]==1.7.4 ; extra == "test"
Requires-Dist: black==22.1.0 ; extra == "test"
Requires-Dist: check-manifest==0.48 ; extra == "test"
Requires-Dist: flake8-bugbear==22.1.11 ; extra == "test"
Requires-Dist: flake8-docstrings ; extra == "test"
Requires-Dist: flake8-formatter_junit_xml ; extra == "test"
Requires-Dist: flake8==4.0.1 ; extra == "test"
Requires-Dist: pre-commit==2.17.0 ; extra == "test"
Requires-Dist: pylint==2.12.2 ; extra == "test"
Requires-Dist: pylint_junit ; extra == "test"
Requires-Dist: pytest-cov==3.0.0 ; extra == "test"
Requires-Dist: pytest-runner ; extra == "test"
Requires-Dist: pytest==7.1.0 ; extra == "test"
Requires-Dist: pytest-github-actions-annotate-failures ; extra == "test"
Project-URL: Documentation, https://github.com/federicobond/boringavatars
Project-URL: Source, https://github.com/federicobond/boringavatars
Project-URL: Tracker, https://github.com/federicobond/boringavatars
Provides-Extra: test


# Boring Avatars

boringavatars is a Python port of the <a href="https://www.npmjs.com/package/boring-avatars">boring-avatars</a> JS library.

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Install

```
pip install boringavatars
```

## Usage

```python
from boringavatars import avatar

# returns the string corresponding to the generated SVG
avatar(
    "Maria Mitchell",
    variant="marble",
    colors=["92A1C6", "146A7C", "F0AB3D", "C271B4", "C20D90"],
    title=False,
    size=40,
    square=True,
)
```

## License

MIT

