Skip to main content

Barcode rendering for Python supporting QRcode, Aztec, PDF417, I25, Code128, Code39 and many more types.

Project description

https://img.shields.io/github/actions/workflow/status/adamchainz/treepoem/main.yml.svg?branch=main&style=for-the-badge https://img.shields.io/pypi/v/treepoem.svg?style=for-the-badge https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge pre-commit

A cleverly named, but very simple python barcode renderer wrapping the BWIPP library and ghostscript command line tool.


Improve your Django and Git skills with one of my books.


Installation

Install from pip:

python -m pip install treepoem

Python 3.9 to 3.13 supported.

You’ll also need Ghostscript installed. On Ubuntu/Debian this can be installed with:

apt-get install ghostscript

On Mac OS X use:

brew install ghostscript

Otherwise refer to your distribution’s package manager, though it’s likely to be called ghostscript too.

There’s a known issue with rendering on Ghostscript 9.22+ where images are smeared. See GitHub Issue #124 and its associated links for more details. Ghostscript merged a fix in version 9.26 and common barcodes seem to work from then on, though still with some smearing.

You can check your Ghostscript version with:

gs --version

API

generate_barcode(barcode_type: str, data: str | bytes, options: dict[str, str | bool] | None=None, *, scale: int = 2) -> Image

Generates a barcode and returns it as a PIL Image object

barcode_type is the name of the barcode type to generate (see below).

data is a str or bytes of data to embed in the barcode - the amount that can be embedded varies by type.

options is a dictionary of strings-to-strings of extra options to be passed to BWIPP, as per its docs.

scale controls the output image size. Use 1 for the smallest image and larger values for larger images.

For example, this generates a QR code image, and saves it to a file using Image.save():

import treepoem

image = treepoem.generate_barcode(
    barcode_type="qrcode",  # One of the BWIPP supported codes.
    data="barcode payload",
)
image.convert("1").save("barcode.png")

If your barcode image is monochrome, with no additional text or colouring, converting the Image object to monochrome (image.convert("1")) will likely reduce its file size.

barcode_types: dict[str, BarcodeType]

This is a dict of the ~100 names of the barcode types that the vendored version of BWIPP supports: its keys are strs of the barcode type encoder names, and the values are instances of BarcodeType.

BarcodeType

A class representing meta information on the types. It has two attributes:

  • type_code - the value needed for the barcode_type argument of generate_barcode() to use this type.

  • description - the human level description of the type which has two str.

Only these common types are used in the test suite:

Command-line interface

Treepoem also includes a simple command-line interface to the functionality of generate_barcode. For example, these commands will generate two QR codes with identical contents, but different levels of error correction (see QR Code Options):

$ treepoem -o barcode1.png -t qrcode "This is a test" eclevel=H
$ treepoem -o barcode2.png -t qrcode "^084his is a test" eclevel=L parse

Complete usage instructions are shown with treepoem --help.

What’s so clever about the name?

Barcode.

Bark ode.

Tree poem.

Updating BWIPP

For development of treepoem, when there’s a new BWIPP release:

  1. Run ./download_bwipp.py with the version of BWIPP to download.

  2. Run ./make_data.py to update the barcode types that treepoem knows about.

  3. Add a note in CHANGELOG.rst about the upgrade, adapting from the previous one.

  4. Commit and make a pull request, adapting from previous examples.

Project details


Download files

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

Source Distribution

treepoem-3.26.0.tar.gz (374.9 kB view details)

Uploaded Source

Built Distribution

treepoem-3.26.0-py3-none-any.whl (371.6 kB view details)

Uploaded Python 3

File details

Details for the file treepoem-3.26.0.tar.gz.

File metadata

  • Download URL: treepoem-3.26.0.tar.gz
  • Upload date:
  • Size: 374.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for treepoem-3.26.0.tar.gz
Algorithm Hash digest
SHA256 e2c273db85f521b92e864ec1ebefd19ed5635396ca048e87ba6fe9cfa6f6ed26
MD5 50130bc5a0d7f2c647b5419a867f113f
BLAKE2b-256 22cb556e10b6416d1e85d6c512f3407fae605c964b9e0c85211238893df68e25

See more details on using hashes here.

Provenance

The following attestation bundles were made for treepoem-3.26.0.tar.gz:

Publisher: main.yml on adamchainz/treepoem

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file treepoem-3.26.0-py3-none-any.whl.

File metadata

  • Download URL: treepoem-3.26.0-py3-none-any.whl
  • Upload date:
  • Size: 371.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for treepoem-3.26.0-py3-none-any.whl
Algorithm Hash digest
SHA256 17716a6d40784ff93f174c53ec0c1a8d372abc1e6d7f9a0b414ce753c3d98ff5
MD5 82d0b59ec0c2ee9e5b6fe8baa6840e70
BLAKE2b-256 ed4727fd6a3461be37dc5e80e96b2622a736eb676e7b83bbcf1021b94718a794

See more details on using hashes here.

Provenance

The following attestation bundles were made for treepoem-3.26.0-py3-none-any.whl:

Publisher: main.yml on adamchainz/treepoem

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page