Amazing-QR

转到中文版

Overview

Python QR Code Generator

Generate common qr-code, artistic qr-code (black & white or colorized), animated qr-code (black & white or colorized).

Contents

• Amazing-QR
  • Overview
  • Contents
  • Examples
  • Install
    • CLI or Library
    • Agent Integration
  • Usage
    • CLI
    • Library
    • Agent
  • Tips
  • Supported Characters
  • Environment
  • License
  • Buy me a coffee ☕️

Examples

Install

CLI or Library

pip install amzqr

Agent Integration

To use amazing-qr inside an agent, you can either install the agent skill or connect the MCP server.

Agent Skill

x-hw/skills repository ships the generate-amazing-qr-code skill, which teaches AI agents to generate QR codes with the amzqr CLI. Install it into your agent with:

npx skills add x-hw/skills --skill generate-amazing-qr-code

MCP Server

For MCP-compatible agents, use x-hw/amzqr-mcp.

Usage

CLI

# summary
amzqr Words
      [-v {1,2,3,...,40}]
      [-l {L,M,Q,H}]
      [-n output-filename]
      [-d output-directory]
      [-p picture_file]
      [-c]
      [-con contrast]
      [-bri brightness]
      [-V]

• see Common QR-Code for Words, -v, -l, -n, -d
• see Artistic QR-Code for -p, -c, -con, -bri
• see Animated GIF QR-Code about GIF

Common QR-Code

#1 Words
amzqr https://github.com

• Just input a URL or a sentence, then get your QR-Code named 'qrcode.png' in the current directory.

#2 -v, -l
amzqr https://github.com -v 10 -l Q

• The default size of QR-Code depends both on the numbers of words you input and the level, while the default level (Error Correction Level) is H (the highest).

• Customize: If you want to control the size and the error-correction-level, use the -v and -l arguments.

  -v representing the length is from a minimum of 1 to a maximum of 40.

  -l representing the error correction level is one of L, M, Q and H, where L is the lowest level and H is the highest.

#3 -n, -d
amzqr https://github.com   -n github_qr.jpg   -d .../paths/

• The default output-filename is 'qrcode.png', while the default output-directory is current directory.

• Customize: You can name the output-file and decide the output-directory. Notice that if the name is as same as a existing file, the old one will be deleted.

  -n representing the output-filename could be in the format one of .jpg， .png ，.bmp ，.gif .

  -d means directory.

Artistic QR-Code

#1 -p
amzqr https://github.com -p github.jpg

• The -p is to combine the QR-Code with the following picture which is in the same directory as the program. The resulting picture is black and white by default.

#2 -c
amzqr https://github.com -p github.jpg -c

• The -c is to make the resulting picture colorized.

#3 -con, -bri
amzqr https://github.com -p github.jpg [-c] -con 1.5 -bri 1.6

• The -con flag changes the contrast of the picture - a low number corresponds to low contrast and a high number to high contrast. Default: 1.0.

• The -bri flag changes the brightness and the parameter values work the same as those for -con. Default: 1.0.

Animated GIF QR-Code

The only difference from Artistic QR-Code mentioned above is that you should input an image file in the .gif format. The you can get your black-and-white or colorful qr-code. Remember that when you use -n to customize the output-filename, then the output-filename must end by .gif.

Library

from amzqr import amzqr

version, level, qr_name = amzqr.run(
    words,
    version=1,
    level="H",
    picture=None,
    colorized=False,
    contrast=1.0,
    brightness=1.0,
    save_name=None,
    save_dir=os.getcwd(),
)

details about each parameter are as mentioned above

# help(amzqr)
Positional parameter
   words: str

Optional parameters
   version: int, from 1 to 40
   level: str, just one of ('L','M','Q','H')
   picture: str, a filename of a image
   colorized: bool
   contrast: float
   brightness: float
   save_name: str, the output filename like 'example.png'
   save_dir: str, the output directory

Agent

After installation, just ask your agent to generate a QR code and it will pick up the skill or mcp server automatically.

Tips

• Use a nearly square picture instead of a rectangle one.

• If the size of the picture is large, you should also choose a rightly large -v instead of using the default one.

• If part of the picture is transparent, the qr code will look like:

  You can change the transparent layer to white, and then it will look like:

Supported Characters

• Numbers: 0~9

• Letters: a~z, A~Z

• Common punctuations:

  · , . : ; + - * / \ ~ ! @ # $ % ^ & ` ' = < > [ ] ( ) ? _ { } | and  (space)
  

Environment

• Python 3

License

• GPLv3

Buy me a coffee

Since the GitHub Sponsors is unavailable in China yet...

<img src="https://github.com/x-hw/amazing-qr/blob/master/example/wechatpay.jpg" width = "124" height = "116" alt="wechatpay" align=center />

<img src="https://github.com/x-hw/amazing-qr/blob/master/example/alipay.gif" width = "132" height = "132" alt="alipay" align=center />

🎉🎉🎉 Thanks for your support. 🎉🎉🎉