🔳 qrstyle

rounded	square	dots

Styled QR codes for Python

Rounded, square or dots, with a logo in the centre. Draws to a Pillow image, PNG or WEBP bytes, or a file.

Installation

pip install qrstyle

Usage

import qrstyle

code = qrstyle.make("https://example.com")

code.save("qrcode.png", 512)  # format from the extension: .png or .webp
image = code.to_image(512)  # PIL.Image, 512 x 512
data = code.to_bytes(512, "webp")  # "png" by default

In async code:

code = await qrstyle.amake("https://example.com")
data = await code.ato_bytes(512)

Everything make() accepts:

code = qrstyle.make(
    "https://example.com",  # text to encode
    style="rounded",  # "rounded" | "square" | "dots", the logo follows it
    logo=None,  # PNG or JPEG bytes, up to 5 MB and 4096 x 4096 px
)

The logo goes in as bytes, from a file or downloaded by URL:

from pathlib import Path
from urllib.request import urlopen

logo = Path("logo.png").read_bytes()
# or: logo = urlopen("https://example.com/logo.png", timeout=10).read()

code = qrstyle.make("https://example.com", style="dots", logo=logo)

Errors

• DataTooLongError — the text does not fit a QR code or the size; code.min_size is the smallest size that fits
• LogoError — the logo is not a PNG or JPEG, or is over 5 MB or 4096 x 4096 px
• ValueError — a wrong style or format, or a size over 4096

DataTooLongError and LogoError are QRError.

HTTP API

The same codes over HTTP, in api/:

git clone https://github.com/nessshon/qrstyle.git && cd qrstyle/api
docker compose up -d --build

GET /create returns an image:

curl -G https://example.com/create \
  --data-urlencode "data=https://example.com" \
  --data-urlencode "logo=https://example.com/logo.png" \
  -d style=dots -o qrcode.png

Errors come as JSON {"detail": "..."}

• 400 — the logo can't be used or the text does not fit
• 422 — a wrong parameter

License

This repository is distributed under the MIT License.