pyzxing documentation

pyzxing provides reliable Python bindings for the ZXing barcode decoder. It uses a versioned Java Runner with a pinned checksum so applications receive a stable Python result schema across supported operating systems.

Start with Installation and Quick start. The Usage and Result schema guides describe the public behavior in more detail, while API reference is generated from the Python package.

User guide

• Installation
  • Requirements
  • PyPI
  • conda-forge
  • Installing from source
• Quick start
• Usage
  • Files and globs
  • Decode hints
  • NumPy arrays
  • Errors and timeouts
• Result schema
  • Core fields
  • Binary fields
  • Geometry and metadata
  • Example
• Deployment
  • Runner cache
  • PyInstaller
  • Containers
  • Webcam example
• Troubleshooting
  • Java was not found
  • Runner download fails
  • No files found
  • Binary QR text looks corrupted
  • NumPy decoding cannot import OpenCV
  • Timeouts or large files

Reference

• API reference
  • Public reader
  • Exceptions
• Development
  • Python environment
  • Java Runner
  • Documentation
  • Release checks

Project resources

• Source code

• Issue tracker

• Release notes

• PyPI package

• conda-forge package