Metadata-Version: 2.1
Name: makeqr
Version: 4.1.0rc1
Summary: Generate QR cards for any occasion
Home-page: https://github.com/shpaker/makeqr
Author: Aleksandr Shpak
Author-email: shpaker@gmail.com
Requires-Python: >=3.7.2,<4.0.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Communications
Requires-Dist: click (>=8.1.3,<9.0.0)
Requires-Dist: pydantic[email] (>=1.8.2,<2.0.0)
Requires-Dist: qrcode[pil] (>=7.3.1,<8.0.0)
Project-URL: Repository, https://github.com/shpaker/makeqr
Description-Content-Type: text/markdown

# MakeQR

Generate WiFi Access QR Codes

# Installation

```bash
pip install makeqr -U
```

# Usage example

## To test that installation was successful, try:

```bash
makeqr --help
```

or

```bash
makeqr wifi --help
```

## Command line command

### Command

```bash
makeqr -p wifi --ssid ABC --password Tfsjfklasdjfklasdest -s wpa2
```

### Output

```plain
 __   __  _______  ___   _  _______  _______  ______
|  |_|  ||   _   ||   | | ||       ||       ||    _ |
|       ||  |_|  ||   |_| ||    ___||   _   ||   | ||
|       ||       ||      _||   |___ |  | |  ||   |_||_
|       ||       ||     |_ |    ___||  |_|  ||    __  |
| ||_|| ||   _   ||    _  ||   |___ |      | |   |  | |
|_|   |_||__| |__||___| |_||_______||____||_||___|  |_|

DATA MODEL
{"ssid": "ABC", "security": "wpa2", "password": "Tfsjfklasdjfklasdest", "hidden": false}

QR STRING
WIFI:S:ABC;P:Tfsjfklasdjfklasdest;T:WPA;;

RESULT
                                                              
  ██████████████        ████  ██████  ██████  ██████████████  
  ██          ██    ██  ██████████        ██  ██          ██  
  ██  ██████  ██  ██████  ██  ██      ████    ██  ██████  ██  
  ██  ██████  ██  ██  ██      ██  ████    ██  ██  ██████  ██  
  ██  ██████  ██  ██    ██    ██    ████████  ██  ██████  ██  
  ██          ██  ██  ██████    ██  ████  ██  ██          ██  
  ██████████████  ██  ██  ██  ██  ██  ██  ██  ██████████████  
                  ██  ██████    ████  ██                      
  ██  ██████████      ██      ████████        ██████████      
        ██  ██  ██  ██    ██    ████  ██████  ██  ██  ████    
  ██    ██  ████████    ████    ██████      ████  ████        
  ██████    ██  ██  ██  ██    ██      ██  ██████  ██    ████  
  ██          ██  ████  ██  ██    ████  ██      ████████      
        ██  ██    ██████  ██████    ████████    ████  ████    
    ██  ████  ████  ██████  ██  ██  ████  ██    ██    ██      
    ████  ████          ██    ██████    ██  ██      ██        
    ██████    ██  ████████████  ██████  ██      ██  ██  ████  
  ██      ████        ██    ████  ██████████████  ██    ██    
  ██      ██  ████    ██  ████  ████            ██  ████      
  ██  ██████        ██████    ██      ██████████  ██      ██  
  ██  ████  ██████      ████    ██████    ██████████████      
                  ██  ██    ██    ██  ██  ██      ██  ██      
  ██████████████      ██  ██████████  ██████  ██  ██  ██      
  ██          ██  ████  ██  ██  ████    ████      ████        
  ██  ██████  ██  ██  ██      ████  ██    ██████████    ████  
  ██  ██████  ██  ██    ████      ██      ██      ██    ████  
  ██  ██████  ██  ██    ██    ████  ████  ██  ████████  ██    
  ██          ██    ██  ██    ██████      ████      ██  ██    
  ██████████████  ██  ██        ██  ██  ██    ██  ██          

```

## Docker container

```bash
docker run ghcr.io/shpaker/makeqr:4.0.1 -p link https://t.me/shpaker

```

## As python module

```python
from makeqr import MakeQR, QRMailToModel

model = QRMailToModel(
  to='foo@bar.baz',
  subject='Awesome subject!',
)
qr = MakeQR(model)
data: bytes = qr.make_image_data()
```

