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 :doc:`installation` and :doc:`quickstart`. The :doc:`usage` and
:doc:`results` guides describe the public behavior in more detail, while
:doc:`api` is generated from the Python package.

.. toctree::
   :maxdepth: 2
   :caption: User guide

   installation
   quickstart
   usage
   results
   deployment
   troubleshooting

.. toctree::
   :maxdepth: 2
   :caption: Reference

   api
   development

Project resources
-----------------

* `Source code <https://github.com/ChenjieXu/pyzxing>`_
* `Issue tracker <https://github.com/ChenjieXu/pyzxing/issues>`_
* `Release notes <https://github.com/ChenjieXu/pyzxing/blob/master/CHANGELOG.md>`_
* `PyPI package <https://pypi.org/project/pyzxing/>`_
* `conda-forge package <https://anaconda.org/conda-forge/pyzxing>`_