MakeQR

Name	MakeQR JSON
Version	4.4.1 JSON
	download
home_page	https://github.com/shpaker/makeqr
Summary	Generate QR cards for any occasion
upload_time	2024-03-07 12:16:55
maintainer
docs_url	None
author	Aleksandr Shpak
requires_python	>=3.9,<4.0.0
license
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # MakeQR

[![PyPI](https://img.shields.io/pypi/v/makeqr.svg)](https://pypi.python.org/pypi/makeqr)
[![PyPI](https://img.shields.io/pypi/dm/makeqr.svg)](https://pypi.python.org/pypi/makeqr)

Generate WiFi Access QR Codes

# Installation

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

## To test that installation was successful, try:

```bash
makeqr --help
```

or

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

# Usage example

## Command line command

### Command

```bash
makeqr -v wifi --password TopSecret --security wpa2 HomeWiFi
```

### Output

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

Model: {"ssid": "HomeWiFi", "security": "wpa2", "password": "TopSecret", "hidden": false}
Encoded: WIFI:S:HomeWiFi;P:TopSecret;T:WPA;;
                                                              
  ██████████████  ████    ██████  ██  ██      ██████████████  
  ██          ██    ██████████████      ██    ██          ██  
  ██  ██████  ██      ██      ██    ██████    ██  ██████  ██  
  ██  ██████  ██  ██████          ██  ██  ██  ██  ██████  ██  
  ██  ██████  ██  ██    ████          ████    ██  ██████  ██  
  ██          ██  ██  ████        ██████████  ██          ██  
  ██████████████  ██  ██  ██  ██  ██  ██  ██  ██████████████  
                  ████  ██████    ██████                      
  ██      ██  ██████████    ██  ██████  ██  ██████████    ██  
  ██    ██      ██    ████  ██████            ████████        
    ██████████████      ████    ██        ████    ████    ██  
  ██        ██  ████    ██    ██  ████  ████  ██        ██    
    ██████    ██    ██      ██████████    ████  ████    ██    
  ██    ██        ████    ██    ██    ██        ██████        
  ████████    ████    ████████████  ████      ██      ██  ██  
            ██  ██      ██  ██  ████████  ████      ██    ██  
      ██      ██    ██    ████      ██  ██  ██        ██  ██  
  ██    ██      ██      ████████  ██    ██    ██████████      
      ██    ████  ████  ██      ████████    ██      ████  ██  
        ██████  ████████████  ████████  ██    ██  ██          
  ████    ██  ██  ██      ██████  ██████  ██████████    ██    
                  ██████  ██      ████    ██      ████  ██    
  ██████████████  ██        ██████      ████  ██  ██  ██  ██  
  ██          ██        ██  ██      ████  ██      ████        
  ██  ██████  ██  ██  ██  ████    ██    ████████████████      
  ██  ██████  ██              ██  ██    ████        ██    ██  
  ██  ██████  ██    ██          ████████                ████  
  ██          ██            ████  ████  ██  ██    ████  ████  
  ██████████████  ████████    ██████████  ████████  ██  ██    
                                                              
```

## Docker container

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

## As python module

```python
from makeqr import MakeQR, QRMailToModel

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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/shpaker/makeqr",
    "name": "MakeQR",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9,<4.0.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Aleksandr Shpak",
    "author_email": "shpaker@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/82/8a/6bd8e269fbf2dd85843913303ae697472260753c1bab1ca8f40eebe869e5/makeqr-4.4.1.tar.gz",
    "platform": null,
    "description": "# MakeQR\n\n[![PyPI](https://img.shields.io/pypi/v/makeqr.svg)](https://pypi.python.org/pypi/makeqr)\n[![PyPI](https://img.shields.io/pypi/dm/makeqr.svg)](https://pypi.python.org/pypi/makeqr)\n\nGenerate WiFi Access QR Codes\n\n# Installation\n\n```bash\npip install makeqr -U\n```\n\n## To test that installation was successful, try:\n\n```bash\nmakeqr --help\n```\n\nor\n\n```bash\nmakeqr wifi --help\n```\n\n# Usage example\n\n## Command line command\n\n### Command\n\n```bash\nmakeqr -v wifi --password TopSecret --security wpa2 HomeWiFi\n```\n\n### Output\n\n```plain\n __   __  _______  ___   _  _______  _______  ______\n|  |_|  ||   _   ||   | | ||       ||       ||    _ |\n|       ||  |_|  ||   |_| ||    ___||   _   ||   | ||\n|       ||       ||      _||   |___ |  | |  ||   |_||_\n|       ||       ||     |_ |    ___||  |_|  ||    __  |\n| ||_|| ||   _   ||    _  ||   |___ |      | |   |  | |\n|_|   |_||__| |__||___| |_||_______||____||_||___|  |_|\n\nModel: {\"ssid\": \"HomeWiFi\", \"security\": \"wpa2\", \"password\": \"TopSecret\", \"hidden\": false}\nEncoded: WIFI:S:HomeWiFi;P:TopSecret;T:WPA;;\n                                                              \n  \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588    \u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588  \u2588\u2588      \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588  \n  \u2588\u2588          \u2588\u2588    \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588      \u2588\u2588    \u2588\u2588          \u2588\u2588  \n  \u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588      \u2588\u2588      \u2588\u2588    \u2588\u2588\u2588\u2588\u2588\u2588    \u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588  \n  \u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588          \u2588\u2588  \u2588\u2588  \u2588\u2588  \u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588  \n  \u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588  \u2588\u2588    \u2588\u2588\u2588\u2588          \u2588\u2588\u2588\u2588    \u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588  \n  \u2588\u2588          \u2588\u2588  \u2588\u2588  \u2588\u2588\u2588\u2588        \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588          \u2588\u2588  \n  \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588  \u2588\u2588  \u2588\u2588  \u2588\u2588  \u2588\u2588  \u2588\u2588  \u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588  \n                  \u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588    \u2588\u2588\u2588\u2588\u2588\u2588                      \n  \u2588\u2588      \u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588    \u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588    \u2588\u2588  \n  \u2588\u2588    \u2588\u2588      \u2588\u2588    \u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588            \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588        \n    \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588      \u2588\u2588\u2588\u2588    \u2588\u2588        \u2588\u2588\u2588\u2588    \u2588\u2588\u2588\u2588    \u2588\u2588  \n  \u2588\u2588        \u2588\u2588  \u2588\u2588\u2588\u2588    \u2588\u2588    \u2588\u2588  \u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588  \u2588\u2588        \u2588\u2588    \n    \u2588\u2588\u2588\u2588\u2588\u2588    \u2588\u2588    \u2588\u2588      \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588    \u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588    \u2588\u2588    \n  \u2588\u2588    \u2588\u2588        \u2588\u2588\u2588\u2588    \u2588\u2588    \u2588\u2588    \u2588\u2588        \u2588\u2588\u2588\u2588\u2588\u2588        \n  \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588    \u2588\u2588\u2588\u2588    \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588      \u2588\u2588      \u2588\u2588  \u2588\u2588  \n            \u2588\u2588  \u2588\u2588      \u2588\u2588  \u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588      \u2588\u2588    \u2588\u2588  \n      \u2588\u2588      \u2588\u2588    \u2588\u2588    \u2588\u2588\u2588\u2588      \u2588\u2588  \u2588\u2588  \u2588\u2588        \u2588\u2588  \u2588\u2588  \n  \u2588\u2588    \u2588\u2588      \u2588\u2588      \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588    \u2588\u2588    \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588      \n      \u2588\u2588    \u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588  \u2588\u2588      \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588    \u2588\u2588      \u2588\u2588\u2588\u2588  \u2588\u2588  \n        \u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588    \u2588\u2588  \u2588\u2588          \n  \u2588\u2588\u2588\u2588    \u2588\u2588  \u2588\u2588  \u2588\u2588      \u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588    \u2588\u2588    \n                  \u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588      \u2588\u2588\u2588\u2588    \u2588\u2588      \u2588\u2588\u2588\u2588  \u2588\u2588    \n  \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588        \u2588\u2588\u2588\u2588\u2588\u2588      \u2588\u2588\u2588\u2588  \u2588\u2588  \u2588\u2588  \u2588\u2588  \u2588\u2588  \n  \u2588\u2588          \u2588\u2588        \u2588\u2588  \u2588\u2588      \u2588\u2588\u2588\u2588  \u2588\u2588      \u2588\u2588\u2588\u2588        \n  \u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588  \u2588\u2588  \u2588\u2588  \u2588\u2588\u2588\u2588    \u2588\u2588    \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588      \n  \u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588              \u2588\u2588  \u2588\u2588    \u2588\u2588\u2588\u2588        \u2588\u2588    \u2588\u2588  \n  \u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588    \u2588\u2588          \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588                \u2588\u2588\u2588\u2588  \n  \u2588\u2588          \u2588\u2588            \u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588  \u2588\u2588  \u2588\u2588    \u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588  \n  \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588    \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588  \u2588\u2588    \n                                                              \n```\n\n## Docker container\n\n```bash\ndocker run ghcr.io/shpaker/makeqr:4.0.1 link https://t.me/shpaker\n```\n\n## As python module\n\n```python\nfrom makeqr import MakeQR, QRMailToModel\n\nqr = MakeQR(\n  model = QRMailToModel(\n    to='foo@bar.baz',\n    subject='Awesome subject!',\n  )\n)\ndata: bytes = qr.make_image_data()\n```\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Generate QR cards for any occasion",
    "version": "4.4.1",
    "project_urls": {
        "Homepage": "https://github.com/shpaker/makeqr",
        "Repository": "https://github.com/shpaker/makeqr"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c84f093c49daff6e28356c8b617d62a2abc560bd40c01350b7e85a7b9599a4bd",
                "md5": "ea9f6f31be4e0bb6a664f5c9708a1e14",
                "sha256": "e5c8e6569f559d8f159bc70b9bea47c30bbf168fe1631b481fa3d82b62720a1c"
            },
            "downloads": -1,
            "filename": "makeqr-4.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ea9f6f31be4e0bb6a664f5c9708a1e14",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<4.0.0",
            "size": 9306,
            "upload_time": "2024-03-07T12:16:53",
            "upload_time_iso_8601": "2024-03-07T12:16:53.780590Z",
            "url": "https://files.pythonhosted.org/packages/c8/4f/093c49daff6e28356c8b617d62a2abc560bd40c01350b7e85a7b9599a4bd/makeqr-4.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "828a6bd8e269fbf2dd85843913303ae697472260753c1bab1ca8f40eebe869e5",
                "md5": "6a35c4bae95cdbc3fd1cd9fbbbfe91d9",
                "sha256": "4e372916341daddd47f9bc93479ede6fdae8f6ab09e6bb9de2d63f8baac38079"
            },
            "downloads": -1,
            "filename": "makeqr-4.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "6a35c4bae95cdbc3fd1cd9fbbbfe91d9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<4.0.0",
            "size": 8549,
            "upload_time": "2024-03-07T12:16:55",
            "upload_time_iso_8601": "2024-03-07T12:16:55.330558Z",
            "url": "https://files.pythonhosted.org/packages/82/8a/6bd8e269fbf2dd85843913303ae697472260753c1bab1ca8f40eebe869e5/makeqr-4.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-07 12:16:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "shpaker",
    "github_project": "makeqr",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "makeqr"
}