Skip to main content

Cool QRCode

一个用于生成个性化二维码的 Python 库,支持自定义颜色、形状、Logo 和蒙板效果。

示例二维码

特性

  • 🎨 自定义颜色 - 支持命名颜色和十六进制颜色代码
  • ⭐ 预设风格 - 内置 8 种精美配色方案
  • 🔘 自定义形状 - 支持方形和圆形码点
  • 🖼️ 添加 Logo - 支持方形和圆形 Logo
  • 🎭 蒙板效果 - 添加半透明色彩蒙板
  • 💫 万能 API - 通过单一函数支持所有效果组合
  • 🚸 学生友好 - 提供简单易用的中文 API 和教程

安装

pip install cool-qrcode

快速开始

基本使用

from cool_qrcode import make_cool_qrcode

# 最简单的用法
make_cool_qrcode("Hello, World!", filename="basic.png")

使用预设风格

# 使用海洋风格
make_cool_qrcode(
    "Hello, Ocean!",
    style="ocean",
    filename="ocean_style.png"
)

海洋风格

圆形码点

# 使用圆形码点
make_cool_qrcode(
    "Hello, Circle!",
    dot_shape="circle",
    fill_color="green",
    back_color="white",
    filename="circle_dots.png"
)

圆形码点

# 添加圆形Logo
make_cool_qrcode(
    "Hello, Logo!",
    logo_path="your_logo.png",
    logo_circular=True,
    filename="with_logo.png"
)

带Logo

组合所有效果

# 组合多种效果
make_cool_qrcode(
    "Hello, Cool QRCode!",
    style="berry",        # 使用预设风格
    dot_shape="circle",   # 圆形码点
    logo_path="logo.png", # 添加Logo
    logo_circular=True,   # 圆形Logo
    mask_color="purple",  # 紫色蒙板
    mask_opacity=0.15,    # 透明度
    size=600,             # 大尺寸
    filename="cool_qr.png"
)

文档

make_cool_qrcode() 万能 API

make_cool_qrcode(
    data,                  # 二维码内容
    filename=None,         # 保存文件名
    size=500,              # 图片大小
    fill_color="black",    # 前景色
    back_color="white",    # 背景色
    style=None,            # 预设风格
    dot_shape="square",    # 码点形状
    logo_path=None,        # Logo路径
    logo_circular=True,    # Logo是否为圆形
    mask_color=None,       # 蒙板颜色
    mask_opacity=0.3       # 蒙板透明度
)

详细使用方法参见 API 文档。

支持的颜色

支持多种命名颜色和十六进制颜色代码,包括:

  • 基础颜色:red, green, blue, yellow, purple, orange...
  • 常用颜色:aqua, fuchsia, lime, maroon, navy, olive...
  • 扩展颜色:lightblue, darkgreen, lavender...

详细颜色列表参见 颜色参考。

预设风格

内置 8 种精美配色方案:

  • ocean - 海洋风格(蓝色系)
  • forest - 森林风格(绿色系)
  • sunset - 日落风格(橙色系)
  • berry - 浆果风格(紫色系)
  • fire - 火焰风格(红色系)
  • mint - 薄荷风格(青色系)
  • chocolate - 巧克力风格(棕色系)
  • night - 夜空风格(深蓝系)

示例

详细示例代码见 examples 目录。

许可证

本项目采用 MIT 许可证 - 详见 LICENSE 文件

Metadata

Release files for cool-qrcode 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cool-qrcode 0.1.3
File Size Uploaded Provenance Actions
cool_qrcode-0.1.3.tar.gz 60.8 kB Without provenance Details for cool_qrcode-0.1.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cool-qrcode 0.1.3
File Interpreter ABI Platform Actions
cool_qrcode-0.1.3-py3-none-any.whl Python 3 none any Details for cool_qrcode-0.1.3-py3-none-any.whl

Total release size: 72.8 kB

Release files / cool_qrcode-0.1.3.tar.gz

Download URL cool_qrcode-0.1.3.tar.gz
Size 60.8 kB
Tags Source
SHA-256 checksum
How to use checksums
913d299856cac4a3dd68e3d5a595405576f63a17add6abed7b7d985273bf42ba
BLAKE2b-256 checksum
How to use checksums
4940273243894f36d916c0ff9db144c30c8b49f639decee23382dbc33d3167f7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.11

Release files / cool_qrcode-0.1.3-py3-none-any.whl

Download URL cool_qrcode-0.1.3-py3-none-any.whl
Size 12.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d0872c050497fb13b6d5ef0eb13da8333d57dde23043f2eef0071a6c45bb0ed2
BLAKE2b-256 checksum
How to use checksums
de01b3b410cdacf111030ee111ba0e1f1898e18b3eb91627aa724962aa450a6a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.11

Security for cool-qrcode 0.1.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page