Metadata-Version: 2.1
Name: boringavatars
Version: 1.0.3
Summary: A Python port of the boring-avatars JS library.
Project-URL: Documentation, https://github.com/federicobond/boringavatars
Project-URL: Source, https://github.com/federicobond/boringavatars
Project-URL: Tracker, https://github.com/federicobond/boringavatars
Author-email: Federico Bond <federicobond@gmail.com>
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
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
Requires-Python: >=3.8
Requires-Dist: jinja2>=3.0.0
Provides-Extra: test
Requires-Dist: black==23.12.1; extra == 'test'
Requires-Dist: check-manifest==0.48; extra == 'test'
Requires-Dist: pre-commit==3.5.0; extra == 'test'
Description-Content-Type: text/markdown


# Boring Avatars

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

![Build Status](https://github.com/federicobond/boringavatars/actions/workflows/python-package.yml/badge.svg?branch=main)
[![Supported Versions](https://img.shields.io/pypi/pyversions/boringavatars.svg)](https://pypi.python.org/pypi/boringavatars)
[![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
