x-hw /amazing-qr

💮 amazing QRCode generator (supporting animated gif) - amazing 二维码生成器(支持 gif 动态图片二维码)

★ 10,849⑂ 1,576👁 298⑃ 39● 85▤ 0
PythonCreated 2016-08-25
+0
Daily
+0
Weekly
+13
Monthly
10,849
stars
1,576
forks
298
watchers
39
prs
85
issues
0
releases

README

Amazing-QR

   !PyPI - Python Version  !PyPI - Wheel   !GitHub code size in bytes !macos !linux !windows

 

转到中文版

 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

python
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:

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


 MCP Server

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


 Usage

 CLI

sh
 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

!

markdown
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.


markdown
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.




markdown
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

!!


markdown
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.


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


 The -c is to make the resulting picture colorized.



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


 The -con flag changes

Snapshot: 2026-11-04T14:00:00Z · Data license Apache-2.0 · JSON