brsx-qrx

Python client and command-line tool for BRSX Qrx QR code generation. No dependencies beyond the standard library.

pip install brsx-qrx

Get an API key

Sign in to qrx.brsxlabs.com, click your name at the top right, open API keys and create one. The key starts with brsxq_ and is shown only once.

export BRSX_QRX_KEY=brsxq_...

Every QR code you generate counts against your daily quota.

Python

from brsx_qrx import Qrx

qrx = Qrx()                                   # reads BRSX_QRX_KEY

qrx.create("https://brsxlabs.com", path="site.png")     # writes the file
png = qrx.create("hello", size=600)                     # or get the bytes

print(qrx.read("site.png"))                             # https://brsxlabs.com

u = qrx.usage()
print(u.plan, u.remaining, "of", u.daily_limit)

Typed QR codes

types() lists what the server supports; each type takes its own fields.

print(qrx.types())                            # {'text': 'Metin', 'url': ...}

qrx.create_typed("wifi", {"ssid": "BRSX", "password": "1234", "encryption": "WPA"},
                 path="wifi.png")

Encrypted content

qrx.create_typed("text", {"text": "secret"}, path="s.png", password="abc")

r = qrx.read("s.png")
print(r.encrypted, r.content)                 # True None

print(qrx.read("s.png", password="abc").content)   # secret

Errors

Command line

brsx-qrx usage
brsx-qrx types
brsx-qrx create "https://brsxlabs.com" -o site.png
brsx-qrx create "secret" -o s.png --password abc
brsx-qrx create -o wifi.png --type wifi --field ssid=BRSX --field password=1234
brsx-qrx read site.png
brsx-qrx read s.png --password abc

With no -o, the PNG goes to stdout:

brsx-qrx create "https://brsxlabs.com" > qr.png

HTTP API

All endpoints take Authorization: Bearer brsxq_....

License

MIT