amazing-qr README

The project's README from github.com/x-hw/amazing-qr. As one markdown file: README.md.

Amazing-QR

former name PyPI - Downloads PyPI - Python Version PyPI PyPI - Wheel PyPI - Downloads PyPI - License GitHub code size in bytes macos linux windows

sponsor

转到中文版

Overview

Python QR Code Generator

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

Contents

Examples

Install

# via pip
pip install amzqr

Usage

Terminal Way

(TIPS: If you haven't install amzqr, you should python(3) amzqr.py instead of amzqr blow.)

# 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]

Common QR-Code

#1 Words
amzqr https://github.com

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

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

Artistic QR-Code

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

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

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

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.

Import Way

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

Tips

Supported Characters

Environment

License

Buy me a coffee

GitHub Sponsors

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

wechatpay

wechatpay

alipay

alipay

🎉🎉🎉 Thanks for your support. 🎉🎉🎉

amazing-qr (x-hw/amazing-qr)

Searching Database…

10.8K ·GitHub
Amazing-qr
Что это такое?Amazing-QR — это генератор QR-кодов на Python: он создаёт обычные коды, художественные коды, наложенные на картинку (чёрно-белую или цветную), и анимированные коды из GIF.
Это утилита для командной строки или библиотека для Python?И то, и другое: через терминал доступна команда amzqr, а можно импортировать её и генерировать коды из своего кода на Python с теми же параметрами.
Как сделать свой первый QR-код?Запустите его со ссылкой или текстом — файл qrcode.png появится в текущей папке; параметр -n задаёт своё имя файла, а -d — другую папку для сохранения.
Что нужно установить, чтобы запустить?Только Python 3 — никаких других зависимостей не указано.
Есть ли подводные камни у настройки с картинкой?Выбирайте почти квадратную картинку, а не вытянутую, берите большее значение -v для крупных изображений и избегайте прозрачности — прозрачные места отображаются плохо, если их не сделать белыми.
Работает ли он на какой-то конкретной системе?Работает везде, где есть Python 3 — на Windows, macOS и Linux — в виде утилиты для терминала; веб-версии или мобильной версии нет.
Пользоваться бесплатно?Да, это бесплатный проект с открытым исходным кодом под лицензией GPLv3.
Что делают флаги -con и -bri с наложенной картинкой?Они регулируют контрастность и яркость, по умолчанию обе равны 1.0; чем выше значение, тем сильнее эффект — так можно настроить, насколько явно картинка проступает сквозь код.
Художественный код с картинкой всё равно будет надёжно сканироваться?Именно на это настроены значения по умолчанию: коррекция ошибок выставлена на максимальный уровень H, а советы (почти квадратная картинка, большее значение -v для крупных изображений, замена прозрачных мест белым) все служат читаемости кода.
Анимированные GIF-коды тоже можно сделать цветными?Да — работает та же опция цвета: подайте .gif и получите чёрно-белый или цветной анимированный QR-код.
What are similar projects?qrcp, ttfx, blind_watermark, imewlconverter, gallery-dl, SolidityScanLegend, primitive, caire
Which topics is it in?gif, qr-code, image, cli-tool, image-processing, skills, animation, utility, command-line, gplv3, command-line-tool, mcp
Creator
x-hw
Size
8.2 MB
Stars
10.8K
Updated
CommitSep 17
Age
10y
Commits · 90 Days