Metadata-Version: 2.5
Name: lupaxa-qrcode-generator
Version: 0.2.0
Summary: CLI and library to generate QR codes for text, Wi-Fi, contacts, email, SMS, locations, and calendar events.
Project-URL: Homepage, https://qrcode-generator.thelupaxaproject.org/
Project-URL: Documentation, https://qrcode-generator.thelupaxaproject.org/
Project-URL: Repository, https://github.com/lupaxa-developers-toolbox/qrcode-generator
Project-URL: Issues, https://github.com/lupaxa-developers-toolbox/qrcode-generator/issues
Author: The Lupaxa Project
License: MIT License
        
        Copyright (c) 2026 The Lupaxa Project
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENCE
Keywords: cli,qr-code,qrcode,segno,vcard,wifi
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: segno>=1.6
Provides-Extra: dev
Requires-Dist: bump-my-version>=1.2.0; extra == 'dev'
Requires-Dist: hatch>=1.12.0; extra == 'dev'
Requires-Dist: mkdocs-material==9.7.7; extra == 'dev'
Requires-Dist: mkdocs==1.6.1; extra == 'dev'
Requires-Dist: mypy>=1.12.0; extra == 'dev'
Requires-Dist: pillow>=10.0; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.6.0; extra == 'dev'
Provides-Extra: logo
Requires-Dist: pillow>=10.0; extra == 'logo'
Provides-Extra: test
Requires-Dist: pillow>=10.0; extra == 'test'
Requires-Dist: pytest-cov>=5.0; extra == 'test'
Requires-Dist: pytest>=8.0; extra == 'test'
Description-Content-Type: text/markdown

<!-- markdownlint-disable -->
<p align="center">
  <a href="https://github.com/lupaxa-developers-toolbox">
    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/developers-toolbox/readme-logo.png" alt="Project Logo" width="256"/><br/>
  </a>
</p>
<h3 align="center">
  The Lupaxa Developers Toolbox<br />
  Part of The Lupaxa Project
</h3>

<br />

# 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

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

### From source (development mode)

```bash
pip install -e ".[dev]"
```

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

## Usage

```python
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")
```

```bash
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

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

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

<a href="https://github.com/the-lupaxa-project">
    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
</a>
