Skip to main content

A ctypes-based wrapper around the libdmtx datamatrix barcode reader.

Project description

Python Versions PyPI version Travis status Coverage Status

A ctypes-based Python wrapper around the libdmtx datamatrix barcode reader.

The pydmtx wrapper is stuck in Python 2.x-land. This ctypes-based wrapper brings libdmtx to Python 2.7 and to Python 3.4 or greater.

Installation

The libdmtx DLLs are included with the Windows Python wheels. On other operating systems, you will need to install the libdmtx shared library.

On Mac OS X:

brew install libdmtx

On Linux:

sudo apt-get install libdmtx0a

Install this Python wrapper; use the second form to install dependencies of the read_datamatrix command-line script:

pip install pylibdmtx
pip install pylibdmtx[scripts]

Example usage

The decode function accepts instances of PIL.Image.

>>> from pylibdmtx.pylibdmtx import decode
>>> from PIL import Image
>>> decode(Image.open('pylibdmtx/tests/datamatrix.png'))
[Decoded(data='Stegosaurus', rect=Rect(left=5, top=6, width=96, height=95)),
 Decoded(data='Plesiosaurus', rect=Rect(left=298, top=6, width=95, height=95))]

It also accepts instances of numpy.ndarray, which might come from loading images using OpenCV.

>>> import cv2
>>> decode(cv2.imread('pylibdmtx/tests/datamatrix.png'))
[Decoded(data='Stegosaurus', rect=Rect(left=5, top=6, width=96, height=95)),
 Decoded(data='Plesiosaurus', rect=Rect(left=298, top=6, width=95, height=95))]

You can also provide a tuple (pixels, width, height)

>>> image = cv2.imread('pylibdmtx/tests/datamatrix.png')
>>> height, width = image.shape[:2]
>>> decode((image.tobytes(), width, height))
[Decoded(data='Stegosaurus', rect=Rect(left=5, top=6, width=96, height=95)),
 Decoded(data='Plesiosaurus', rect=Rect(left=298, top=6, width=95, height=95))]

Limitations

Feel free to submit a PR to address any of these.

  • decoding only - no encoding
  • I took the bone-headed approach of copying the logic in pydmtx’s decode function (in `pydmtxmodule.c <https://sourceforge.net/p/libdmtx/dmtx-wrappers/ci/master/tree/python/>`__); there might be more of libdmtx’s functionality that could be used to read barcodes
  • I exposed the bare minimum of functions, defines, enums and typedefs neede to reimplement pydmtx’s decode function

License

pylibdmtx is distributed under the MIT license (see LICENCE.txt). The libdmtx shared library is distributed under the Simplified BSD license (see libdmtx-LICENCE.txt).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pylibdmtx, version 0.1.4
Filename, size File type Python version Upload date Hashes
Filename, size pylibdmtx-0.1.4-py2.py3-none-any.whl (17.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pylibdmtx-0.1.4-py2.py3-none-win32.whl (52.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pylibdmtx-0.1.4-py2.py3-none-win_amd64.whl (94.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page