Metadata-Version: 2.4
Name: silasyn-qr
Version: 1.0.1
Summary: Official Python wrapper for the Silasyn QR Generation Engine.
Author-email: Silasyn <dev@silasyn.com>
License: MIT
Project-URL: Homepage, https://silasyn.com/tools/qr
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: requests>=2.25.0
Dynamic: license-file

# Silasyn QR Engine (Python Wrapper)

The official Python interface for the **Silasyn QR Generation API**. Generate high-fidelity QR matrices directly from your Python scripts without relying on local image processing libraries.

---

## Installation

Install the package via `pip`:

```bash
pip install silasyn-qr

```

## Quick Start

```python
from silasyn_qr import SilasynQR

# Initialize the engine
qr = SilasynQR()

# Generate a simple URL QR Code and save locally
qr.raw("https://silasyn.com", filename="my_website.png")

# Generate a Wi-Fi QR Code and retrieve the Base64 JSON payload
wifi_data = qr.wifi("MyHomeNetwork", password="SuperSecretPassword", return_base64=True)
print(wifi_data)

```

## Supported Payload Protocols

The wrapper supports a comprehensive suite of structured data payloads:

| Protocol / Method | Parameters | Description |
| --- | --- | --- |
| `.raw(data)` | `data` | Standard URL, plaintext string, or fallback payload |
| `.wifi(ssid, password, ...)` | `ssid`, `password`, `enc`, `hidden` | Wi-Fi hotspot access credentials |
| `.vcard(fn, ln, mob, work, email, comp, title, vurl, adr)` | `fn`, `ln`, `mob`, `work`, `email`, `comp`, `title`, `vurl`, `adr` | Digital Contact Cards (vCard format) |
| `.email(to, sub, body)` | `to`, `sub`, `body` | Pre-composed Email Drafts |
| `.whatsapp(to, msg)` | `to`, `msg` | Direct WhatsApp instant message chats |
| `.sms(to, msg)` | `to`, `msg` | Pre-filled Short Message Service (SMS) text messages |
| `.location(lat, lng)` | `lat`, `lng` | Map coordinates / Geolocation pin drop |
| `.event(title, start, end, loc)` | `title`, `start`, `end`, `loc` | iCal Calendar Events configuration |
| `.upi(vpa, name)` | `vpa`, `name` | Unified Payments Interface (UPI) request matrices |
| `.crypto(addr, coin)` | `addr`, `coin` | Cryptocurrency wallet address routing |

## Advanced Features & Formatting

* **Zero Heavy Dependencies**: Pure API communication layer—no `Pillow`, `opencv`, or heavy matrix libraries required locally.
* **Flexible Outputs**: Choose between direct local file rendering (`filename="out.png"`) or explicit payload retrieval via `return_base64=True`.

---

© 2026 Silasyn. All rights reserved.
