QR Verbose

qr-verbose is a Python package for generating QR codes with detailed visualization desined mainly for educational purposes. You can generate a scannable QR code with qr-verbose, more importantly you can also generate the same QR with intermediate level information rarely available in QR code generators/encoders.

Installation

Install the required dependencies:

pip install qr-verbose

or from sources

git clone https://git@git.sourcecraft.dev/malkovskynv/qr-verbose.git
cd qr-verbose
pip install .

qr-verbose is provided as CLI entry point, check

qr-verbose --help

If qr-verbose is not available check the PATH variable, when the package is installed pip will show a warning about CLI script not being part of the PATH. You can either add the Python bin path to the PATH variable or specify the full path to the installed location of the script.

Usage

You can generate a regular scannable QR code like this

qr-verbose -m 2 -v 3 \
    --logo-path docs/images/logo_example.png \
    --logo-radius=3.5 \
    -e M \
    -o regular.png \
    t.me/a_zachem_eto_nuzhno  

{align=center width=400px}

The same but unmasked and with visual data layout

qr-verbose -m -1 -v 3 \
    --logo-path docs/images/logo_example.png \
    --logo-radius=3.5 \
    -e M \
    -t ascii \
    -o ascii.png \
    t.me/a_zachem_eto_nuzhno  

{align=center width=400px}

The QR at the top of the README is generated via the following command (annotations are manual)

qr-verbose -m 0 -v 3 \
    --logo-path docs/images/logo_example.png \
    --logo-radius=3.5 \
    --logo-transparency=255 \
    -t color \
    -e M \
    -o repo_url.png \
    --white-data-background \
    sourcecraft.dev/malkovskynv/qr-verbose

More examples can be found in the docs