Metadata-Version: 2.3
Name: tiny-userpic
Version: 0.3.2
Summary: Oversimplified Github-like userpic (avatar) generator
Project-URL: Homepage, https://github.com/shpaker/tiny-userpic/
Project-URL: Repository, https://github.com/shpaker/tiny-userpic/
Author-email: Aleksandr Shpak <shpaker@gmail.com>
License: MIT
Keywords: avatar,avatar-generator,userpic
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: pillow>=11.0
Description-Content-Type: text/markdown

# Github-like userpic (avatar) generator

Oversimplified Github-like userpic (avatar) generator

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![PyPI](https://img.shields.io/pypi/v/tiny-userpic.svg)](https://pypi.python.org/pypi/tiny-userpic)
[![PyPI](https://img.shields.io/pypi/dm/tiny-userpic.svg)](https://pypi.python.org/pypi/tiny-userpic)

## Install from PyPI

Library can be installed using pip:

```bash
pip install tiny-userpic
```

## Generate PIL image

```python
from PIL.Image import Image

from userpic import make_userpic_image

# make PIL Image object
image: Image = make_userpic_image(
    size=(7, 5),
    padding=(20, 10),
    mode='RGBA',
    image_size=(300, 600),
    background='white',
    foreground='black',
)

# save as JPEG file
with open('output.jpeg', 'wb') as fp:
    image.save(fp)
```

## Generate SVG data

```python

from userpic import make_userpic_svg

# make PIL Image object
image: str = make_userpic_svg(
  size=(7, 5),
  padding=(20, 10),
  image_size=(300, 600),
  background='white',
  foreground='black',
)

# save as SVG file
with open('output.svg', 'w') as fp:
  fp.write(image)
```

## The result should look something like this

![alt text](example.png)
