Prerequisites & Installation

Ensure your development environment includes Python 3.x. The required package can be deployed via pip:

pip install MyQR

Upon successful deployment, the myqr command becomes accessible in your terminal, residing within the active environment's binary directory.

Command-Line Configuration

The CLI exposes several flags for controlling matrix density, error tolerance, and visual styling:

• -v 1–40: Selects matrix complexity. Larger integers produce denser grids.
• -l L/M/Q/H: Defines error correction capacity. H delivers maximum data recovery.
• -n <name>: Sets the output filename (accepts .png, .jpg, .bmp, .gif).
• -d <path>: Redirects storage location.
• -p <image>: Blends a reference photograph into the QR lattice.
• -c: Switches from monochrome to full-color rendering.
• -con <value>: Calibrates contrast ratios (baseline: 1.0).
• -bri <value>: Tunes luminance, operating identically to contrast scaling.

Terminal Execution Examples

The following commands demonstrate common production patterns:

# Standard monochrome overlay
myqr https://example.com -p assets/base.png

# Chromatic integration
myqr https://example.com -p assets/color_bg.jpg -c

# Grayscale animation export
myqr https://example.com -p assets/sequence.gif -con 0.6

# Full-color animation export
myqr https://example.com -p assets/motion.gif -c -con 0.7

Programmatic Implementation

For automated workflows or embedded applications, invoke the library directly within a Python module. The snippet below wraps execution into a reusable routine with modified parameter defaults:

import os
from myqr import myqr

def compile_qr_graphic(source_text: str, backdrop_image: str = None) -> tuple:
    """Encapsulates MyQR execution with standardized configuration."""
    run_config = {
        "words": source_text,
        "version": 4,
        "level": "H",
        "picture": backdrop_image,
        "colorized": True,
        "contrast": 1.15,
        "brightness": 1.0,
        "save_name": "output_matrix.png",
        "save_dir": os.path.abspath(".")
    }

    matrix_info = myqr.run(**run_config)
    return matrix_info

# Trigger generation pipeline
qr_state = compile_qr_graphic("https://api.reference-service.io/v2")
print(f"Exported {qr_state[2]} at version {qr_state[0]}, correction {qr_state[1]}")

This structure isolates parameter management, enabling dynamic asset injection or batch processing without modifying core CLI syntax. Tuning version, level, and image paths allows precise balancing between machine readability and aesthetic design.