Metadata-Version: 2.4
Name: qrmaster
Version: 1.0.1
Summary: Fast Python QR Code generator & CLI powered by QR Master
Author-email: QR Master Team <support@qrmaster.net>
License-Expression: MIT
Project-URL: Homepage, https://www.qrmaster.net
Project-URL: WiFi QR Generator, https://www.qrmaster.net/tools/wifi-qr-code
Project-URL: vCard QR Generator, https://www.qrmaster.net/tools/vcard-qr-code
Project-URL: WhatsApp QR Generator, https://www.qrmaster.net/tools/whatsapp-qr-code
Project-URL: Source Code, https://github.com/knuthtimo-lab/qrmaster-cli
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Utilities
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: qrcode>=7.4.2
Requires-Dist: pillow>=9.0.0
Dynamic: license-file

# QR Master Python Package & CLI

Generate a QR code where you are already working: in the terminal, as a PNG or SVG file, or inside your Python applications.

Use it for a URL, WiFi access, a contact card, or a WhatsApp chat link—without setting up complex dependencies.

[![PyPI version](https://img.shields.io/pypi/v/qrmaster.svg?style=flat-square)](https://pypi.org/project/qrmaster/)
[![Python versions](https://img.shields.io/pypi/pyversions/qrmaster.svg?style=flat-square)](https://pypi.org/project/qrmaster/)
[![license](https://img.shields.io/github/license/knuthtimo-lab/qrmaster-cli.svg?style=flat-square)](LICENSE)

---

## Start in seconds

Install via `pip`:

```bash
pip install qrmaster
```

Pass any URL or text to `qrmaster`:

```bash
qrmaster "https://www.qrmaster.net"
```

The QR code is printed directly in your terminal so you can scan it right away.

Save a shareable image by adding an output path:

```bash
# PNG image export
qrmaster "https://www.qrmaster.net" --output qr-code.png

# SVG vector export for crisp scaling in print and design tools
qrmaster "https://www.qrmaster.net" --output qr-code.svg
```

---

## Common use cases

### Connect guests to WiFi

```bash
qrmaster --wifi \
  --ssid "Studio-Guest" \
  --password "replace-with-your-password" \
  --output wifi-qr.png
```

Scanning the code opens the device's WiFi connection flow with the supplied network details.

### Share a contact card (vCard)

```bash
qrmaster --vcard \
  --name "Alex Smith" \
  --email "alex@example.com" \
  --phone "+49 30 123456" \
  --output alex-contact.svg
```

### Open a WhatsApp chat

```bash
qrmaster --whatsapp \
  --phone "+49 170 1234567" \
  --output whatsapp-qr.png
```

---

## Command reference

```text
qrmaster <content-or-url> [options]
```

| Option | Description |
| --- | --- |
| `-o, --output <filepath>` | Write a file. Use `.svg` for SVG; any other extension is written as PNG. |
| `--wifi` | Create a WiFi connection QR code. Requires `--ssid`. |
| `--ssid <name>` | WiFi network name; used with `--wifi`. |
| `--password <password>` | WiFi password; used with `--wifi`. |
| `--vcard` | Create a vCard contact QR code. |
| `--name <full-name>` | Contact name; used with `--vcard`. |
| `--email <email>` | Contact email; used with `--vcard`. |
| `--phone <phone>` | Contact telephone number; used with `--vcard` or `--whatsapp`. |
| `--whatsapp` | Create a QR code that opens a WhatsApp chat. Provide a number with `--phone`, or as positional argument. |
| `-h, --help` | Show the built-in help menu. |

---

## Use from Python (SDK API)

Import the module when QR generation belongs inside your Python code or automation scripts:

```python
from qrmaster import (
    generate_qr,
    build_wifi_payload,
    build_vcard_payload,
    build_whatsapp_payload,
)

# Render in terminal and save SVG file
generate_qr("https://www.qrmaster.net", output="qr-code.svg")

# Generate WiFi connector payload
wifi_data = build_wifi_payload(ssid="Studio-Guest", password="replace-with-your-password")
generate_qr(wifi_data, output="wifi-qr.png")

# Generate vCard payload
contact_data = build_vcard_payload(
    name="Alex Smith",
    email="alex@example.com",
    phone="+49 30 123456"
)
generate_qr(contact_data)

# Generate WhatsApp chat payload
whatsapp_data = build_whatsapp_payload(phone="+49 170 1234567", text="Hello!")
generate_qr(whatsapp_data, output="whatsapp-qr.png")
```

---

## Need editable destinations or scan analytics?

This Python package creates static QR codes locally. For destinations you can change after printing, scan analytics, branding, or bulk vector exports, use the [Dynamic QR Code Generator](https://www.qrmaster.net/dynamic-qr-code-generator).

### Restaurant menus: keep the table code, update the menu

Printed menu cards often outlive prices, daily specials, and menu links. A dynamic QR code keeps the QR code on the table unchanged while you update its destination in QR Master. Explore [QR codes for restaurants](https://www.qrmaster.net/restaurants) to see the workflow for digital menus, ordering, feedback, and promotions.

Useful free tools:

- [WiFi QR Code Generator](https://www.qrmaster.net/tools/wifi-qr-code)
- [vCard QR Code Generator](https://www.qrmaster.net/tools/vcard-qr-code)
- [WhatsApp QR Code Generator](https://www.qrmaster.net/tools/whatsapp-qr-code)

---

## License

[MIT](LICENSE) © [QR Master](https://www.qrmaster.net)
