Usage

CLI

branded-qr "https://example.com" path/to/logo.png \
  --target-frac 0.18 --pad-frac 0.28 --smooth-sigma 1.2 \
  --qr-scale 10 --border-modules 4 --error h \
  --module-shape circle --edge-clearance 1.0 \
  --finder-dark-color "#3c2d4d" -o branded_qr.png

Preset branding:

# MQ preset (uses data/mq_colour.png)
branded-qr --university mq "https://example.com" -o data/aas_QR.png

# UniSQ preset (uses data/unisq_shield_plain.png and finder color #3c2d4d)
branded-qr --university unisq "https://example.com" -o data/aas_QR.png

# UQ preset (uses data/uqlogo.png)
branded-qr --university uq "https://example.com" -o data/aas_QR.png

Python API

from branded_qr import make_branded_qr
img = make_branded_qr(
    url="https://example.com",
    logo_path="logo.png",
    finder_dark_color="#3c2d4d"
)
img.save("branded_qr.png")

Using presets via university:

from branded_qr import make_branded_qr
img = make_branded_qr(
  url="https://example.com",
  university="mq",  # mq | unisq | sydney | uq
  save_path="data/aas_QR.png"
)

Build Docs Locally

pip install mkdocs mkdocs-material
mkdocs serve

Open http://127.0.0.1:8000 in your browser.