# qrcode
**Repository Path**: z21/qrcode
## Basic Information
- **Project Name**: qrcode
- **Description**: https://github.com/sylnsfar/qrcode/
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-27
- **Last Updated**: 2025-10-27
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# Amazing-QR
[](https://pypi.org/project/myqr/) [](https://pypi.org/project/myqr/) [](https://www.python.org/)  [](https://pypi.org/project/amzqr/)  [](https://pypi.org/project/amzqr/) [](https://github.com/x-hw/amazing-qr/blob/master/LICENSE.md)    
[](https://github.com/x-hw) [](#打赏杯咖啡)
[*back to English*](https://github.com/x-hw/amazing-qr/blob/master/README.md)
## 概述
**Python 二维码生成器**
可生成*普通二维码*、*带图片的艺术二维码（黑白与彩色）*、*动态二维码（黑白与彩色）*。
## Contents 目录
* [Amazing-QR](#amazing-qr)
* [概述](#概述)
* [目录](#目录)
* [示例](#示例)
* [安装](#安装)
* [使用方法](#使用方法)
* [命令行方式](#命令行方式)
* [作为导入文件](#作为导入文件)
* [使用提示](#使用提示)
* [可用字符](#可用字符)
* [环境](#环境)
* [协议](#协议)
* [打赏杯咖啡☕️](#打赏杯咖啡)
## 示例
## 安装
```python
pip install amzqr
```
## 使用方法
### 命令行方式
*（**提示**：如果你尚未安装 [**amzqr**](https://pypi.python.org/pypi/amzqr) ，以下内容请使用`python(3) amzqr.py` 而非`amzqr` 。）*
```python
# 概括
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]
```
- [普通二维码](#普通二维码) 介绍了 `Words`, `-v`, `-l`, `-n`, `-d`
- [艺术二维码](#艺术二维码) 介绍了 `-p`, `-c`, `-con`, `-bri`
- [动态GIF二维码](#动态gif二维码) 介绍了动态的生成方法和注意点
#### 普通二维码
```markdown
#1 Words
amzqr https://github.com
```
* 在命令后输入链接或者句子作为参数，然后在程序的当前目录中产生相应的二维码图片文件，默认命名为” qrcode.png“。
```markdown
#2 -v, -l
amzqr https://github.com -v 10 -l Q
```
* **默认边长**是取决于你输入的信息的长度和使用的纠错等级；
而**默认纠错等级**是最高级的H。
* **自定义**：如果想要控制边长和纠错水平就使用 `-v` 和 `-l` 参数。
`-v` 控制边长，范围是**1至40**，数字越大边长越大；
`-l` 控制纠错水平，范围是**L、M、Q、H**，从左到右依次升高。
```markdown
#3 -n, -d
amzqr https://github.com -n github_qr.jpg -d .../paths/
```
- **默认输出文件名**是“ qrcode.png "，而**默认存储位置**是当前目录。
- 自定义：可以自己定义输出名称和位置。**注意**同名文件会覆盖旧的。
`-n` 控制文件名，格式可以是 `.jpg`， `.png` ，`.bmp` ，`.gif` ；
`-d` 控制位置。
#### 艺术二维码
```markdown
#1 -p
amzqr https://github.com -p github.jpg
```
* 参数`-p` 用来将QR二维码图像与一张同目录下的图片相结合，产生一张**黑白**图片。
```markdown
#2 -c
amzqr https://github.com -p github.jpg -c
```
* 加上参数 `-c` 可以使产生的图片由黑白变为**彩色**的。
```markdown
#3 -con, -bri
amzqr https://github.com -p github.jpg [-c] -con 1.5 -bri 1.6
```
* 参数`-con` 用以调节图片的**对比度**，1.0 表示原始图片，更小的值表示更低对比度，更大反之。**默认为1.0**。
* 参数 `-bri` 用来调节图片的**亮度**，其余用法和取值与 `-con` 相同。
#### 动态GIF二维码
动态二维码与上述的带图片的二维码的生成方法没什么区别，你只要采用 `.gif` 格式的图片即可生成黑白或者彩色的动态二维码。但**注意**如果使用了 `-n` 参数自定义输出的文件名，切记其格式也必须是 `.gif` 格式。
### 作为导入文件
```python
# 安装模块后
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()
)
```
*以下各个参数已经在[上文](#命令行方式)有所介绍*
```python
# help(amzqr)
Positional parameter
words: str
Optional parameters
version: int, from 1 to 40
level: str, just one of ('L','M','Q','H')
picutre: str, a filename of a image
colorized: bool
constrast: float
brightness: float
save_name: str, the output filename like 'example.png'
save_dir: str, the output directory
```
## 使用提示
* 请采用**正方形**或近似正方形的图片
* 建议在图片尺寸大的时候使用 `-v` 的值也应该**适当**变大。
* 如果图片有透明无色部分，最终效果是：
你可以将透明部分修改成白色，最终效果会变成
## 可用字符
* 数字 0 到 9
* 大小写的英文字母
* 常用**英文标点符号**和空格
```console
· , . : ; + - * / \ ~ ! @ # $ % ^ & ` ' = < > [ ] ( ) ? _ { } | and (space)
```
## 环境
- Python 3
## 协议
* GPLv3
## 打赏杯咖啡
[](https://github.com/sponsors#regions)
*GitHub Sponsors 还用不了...*
🎉🎉🎉 感谢你的支持 🎉🎉🎉