Skip to main content

Project Logo

The Lupaxa Developers Toolbox
Part of The Lupaxa Project


lupaxa-qrcode-generator

CLI and library to generate QR codes for text, Wi-Fi, contacts, email, SMS, locations, and calendar events.

Built for scripts and tools used by The Lupaxa Project.

The PyPI name is lupaxa-qrcode-generator. The import path is lupaxa.qrcode_generator. The CLI is installed as qrcode-generator and qrcodes.

Features

  • Text, URL, Wi-Fi, vCard, tel, email, SMS, geo, and calendar event payloads
  • Error correction, version pin, Micro QR, ECI, and structured-append sequences
  • Colours, --kind, PNG DPI, terminal preview, data URIs, stdout, and optional centre logos ([logo] extra)
  • Library API returns a segno.QRCode; save_qr writes PNG, SVG, and other segno formats
  • CLI with --version, -o / --scale / --border, and a subcommand per type
  • Wi-Fi WPA/WEP requires a password; URLs must be absolute http / https
  • SMS supports RFC ?body= and iOS &body= forms
  • Calendar events emit escaped iCalendar with PRODID, UID, and DTSTAMP
  • Fully typed, linted, formatted, and tested

Installation

From PyPI

pip install lupaxa-qrcode-generator
pip install lupaxa-qrcode-generator[logo]  # centre-logo overlay (Pillow)

From source (development mode)

pip install -e ".[dev]"

Requires Python 3.10+. lupaxa is a namespace package — there is no lupaxa/__init__.py.

Usage

from lupaxa.qrcode_generator import make_text, make_wifi, save_qr

save_qr(make_text("Hello Simon"), "hello.png")
save_qr(make_wifi("MyWifi", password="Secret!", auth="WPA"), "wifi.png")
qrcode-generator text "Hello Simon" -o hello.png
qrcode-generator wifi --ssid "MyWifi" --password "Secret!" --auth WPA -o wifi.png
qrcode-generator url "https://example.com" -o site.png
qrcode-generator --version
qrcode-generator --help

Development

make init
make python-install-dev
make python-check
make mkdocs-serve

Documentation: https://qrcode-generator.thelupaxaproject.org/.

The Lupaxa Project Footer

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lupaxa_qrcode_generator-0.2.1.tar.gz (13.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lupaxa_qrcode_generator-0.2.1-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file lupaxa_qrcode_generator-0.2.1.tar.gz.

File metadata

  • Download URL: lupaxa_qrcode_generator-0.2.1.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for lupaxa_qrcode_generator-0.2.1.tar.gz
Algorithm Hash digest
SHA256 5736335adb25818901f9b9943c3d49d28d43b75cd351c92fd41488693ad6873d
MD5 49f196ed7e136789bf0875d3f96e4493
BLAKE2b-256 6512328a1025fb5ecf76aa0abd8b7522df0833071b5bed84c29a7999a39b7060

See more details on using hashes here.

Provenance

The following attestation bundles were made for lupaxa_qrcode_generator-0.2.1.tar.gz:

Publisher: generate-release.yml on lupaxa-developers-toolbox/qrcode-generator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lupaxa_qrcode_generator-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for lupaxa_qrcode_generator-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 607e4688bfd8fb94f7adc01b63478df058b11326f3ddef04b5bb1ed6369169ce
MD5 13c81231d05cc2991c5395e9db1ab892
BLAKE2b-256 4f2130b762cb58935d8e9b028465621a6f38db7cf103827f5d6ac188eba16b0d

See more details on using hashes here.

Provenance

The following attestation bundles were made for lupaxa_qrcode_generator-0.2.1-py3-none-any.whl:

Publisher: generate-release.yml on lupaxa-developers-toolbox/qrcode-generator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.2.1 This release

2 files

0.2.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page