Skip to main content

Create standard barcodes with Python. No external modules needed. (optional Pillow support included).

Project description

CI status Build coverage documentation version on pypi licence

This library provides a simple way to create barcodes using only the Python standard lib. The barcodes are created as SVG objects.

python-barcode

Full documentation is published at http://python-barcode.rtfd.io/

Please report any bugs at https://github.com/WhyNotHugo/python-barcode/issues

Features

  • Works on Python 3.6 to 3.9

  • No visualiser (just use your browser)

  • Generate barcodes as SVG files.

  • Generate barcodes as images (png, jpeg, etc). Requires Pillow.

Installation

The best way is to use pip: pip install python-barcode. Don’t forget to add this to our app’s dependencies.

If you’ll be exporting to images (eg: not just SVG), you’ll need additional optional dependencies, so run: pip install "python-barcode[images]" (keep the quotes, most shells don’t play nice with square brackets).

Provided Barcodes

  • EAN-8

  • EAN-13

  • EAN-14

  • UPC-A

  • JAN

  • ISBN-10

  • ISBN-13

  • ISSN

  • Code 39

  • Code 128

  • PZN

PRs for other code formats are welcome!

Usage

Programmatic:

from barcode import EAN13
from barcode.writer import ImageWriter

# print to a file-like object:
rv = BytesIO()
EAN13(str(100000902922), writer=ImageWriter()).write(rv)

# or sure, to an actual file:
with open('somefile.jpeg', 'wb') as f:
    EAN13('100000011111', writer=ImageWriter()).write(f)

Interactive:

>>> import barcode
>>> barcode.PROVIDED_BARCODES
['code39', 'code128', 'ean', 'ean13', 'ean8', 'gs1', 'gtin',
 'isbn', 'isbn10', 'isbn13', 'issn', 'jan', 'pzn', 'upc', 'upca']
>>> EAN = barcode.get_barcode_class('ean13')
>>> EAN
<class 'barcode.ean.EuropeanArticleNumber13'>
>>> ean = EAN('5901234123457')
>>> ean
<barcode.ean.EuropeanArticleNumber13 object at 0x00BE98F0>
>>> fullname = ean.save('ean13_barcode')
>>> fullname
'ean13_barcode.svg'
# Example with PNG
>>> from barcode.writer import ImageWriter
>>> ean = EAN('5901234123457', writer=ImageWriter())
>>> fullname = ean.save('ean13_barcode')
'ean13_barcode.png'
# New in v0.4.2
>>> from io import BytesIO
>>> fp = BytesIO()
>>> ean.write(fp)
# or
>>> f = open('/my/new/file', 'wb')
>>> ean.write(f) # Pillow (ImageWriter) produces RAW format here
>>> from barcode import generate
>>> name = generate('EAN13', '5901234123457', output='barcode_svg')
>>> name
'barcode_svg.svg'
# with file like object
>>> fp = BytesIO()
>>> generate('EAN13', '5901234123457', writer=ImageWriter(), output=fp)
>>>

Now open ean13_barcode.[svg|png] in a graphic app or simply in your browser and see the created barcode. That’s it.

Commandline:

`$ python-barcode create "123456789000" outfile -b ean --text "text to appear under barcode" `
New barcode saved as outfile.svg.

# The following will not work if Pillow is not installed (Pillow is required for exporting to images instead of SVG).
$ python-barcode create -t png "My Text" outfile
New barcode saved as outfile.png.

Try `python-barcode -h` for help.

Changelog

v0.13.0

  • Added support for transparent backgrounds. This is done by setting the mode option for a writer to RGBA.

v0.12.0

  • Removed writer_options from barcode.get. This parameter was not used.

  • Add a with_doctype flag to SVGWriter. Set this to false to avoid including a DOCTYPE in the resulting SVG.

  • Add support for Pillow>=8.0.0.

v0.11.0

  • Added basic support for multiline text.

  • Dropped lots of older compat-only code and other cleanups.

  • Fixed a bug in the API when combining certain barcodes and writers.

  • Published documentation again and updated all project references.

  • Fix python_barcode.get mixups between options as writer_options. Previously, some writer/barcode combinations worked fine, while others failed. Now all work consistently.

  • The cli tool has been fixed and should now work as expected again.

v0.10.0

  • Added support for GS1-128.

v0.9.1

  • Officially support Python 3.7

  • Refer to Pillow in the docs, rather than PIL.

v0.9.0

  • Removed buggy Barcode.raw attribute.

  • Various CLI errors ironed out.

  • Make the default value for writer_options` consistent across writers.

v0.8.3

  • Fix pushing of releases to GitHub.

v0.8.2

  • Fix crashes when attempting to use the CLI app.

  • Properly include version numbers in SVG comments.

v0.8.1

  • Improve README rendering, and point to this fork’s location (the outdated README on PyPI was causing some confusion).

v0.8.0

  • First release under the name python-barcode.

Previous Changelog

This project is a fork of pyBarcode, which, apparently, is no longer maintained. v0.8.0 is our first release, and is the latest master from that parent project.

v0.8

  • Code 128 added.

  • Data for charsets and bars moved to subpackage barcode.charsets.

  • Merged in some improvements.

v0.7

  • Fixed some issues with fontsize and fontalignment.

  • Added Python 3 support. It’s not well tested yet, but the tests run without errors with Python 3.3. Commandline script added.

v0.6

  • Changed save and write methods to take the options as a dict not as keyword arguments (fix this in your code). Added option to left align the text under the barcode. Fixed bug with EAN13 generation.

v0.5.0

  • Added new generate function to do all generation in one step.

  • Moved writer from a subpackage to a module (this breaks some existing code). UPC is now rendered as real UPC, not as EAN13 with the leading “0”.

v0.4.3

  • Fixed bug in new write method (related to PIL) and updated docs.

v0.4.2

  • Added write method to support file like objects as target.

v0.4.1

  • Bugfix release. Removed redundancy in input validation.

  • EAN8 was broken. It now works as expected.

v0.4

  • Removed **options from writers __init__ method. These options never had effect. They were always overwritten by default_options.

  • New config option available: text_distance (the distance between barcode and text).

v0.4b2

  • Basic documentation included. The barcode object now has a new attribute called raw to have the rendered output without saving to disk.

v0.4b1

  • Support for rendering barcodes as images is implemented. PIL is required to use it.

v0.3

  • Compression for SVG output now works.

v0.3b1

  • Writer API has changed for simple adding new (own) writers.

  • SVG output is now generated with xml.dom module instead of stringformatting (makes it more robust).

v0.2.1

  • API of render changed. Now render takes keyword arguments instead of a dict.

v0.2

  • More tests added.

v0.1

  • First release.

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

python-barcode-0.13.1.tar.gz (235.9 kB view details)

Uploaded Source

Built Distribution

python_barcode-0.13.1-py3-none-any.whl (217.3 kB view details)

Uploaded Python 3

File details

Details for the file python-barcode-0.13.1.tar.gz.

File metadata

  • Download URL: python-barcode-0.13.1.tar.gz
  • Upload date:
  • Size: 235.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for python-barcode-0.13.1.tar.gz
Algorithm Hash digest
SHA256 fafba4aa24e9d969777be521c294ff18f6c2b36ad63b5fc2f2108d972e23b252
MD5 753dc45364938f3f4f7caad0d72deabe
BLAKE2b-256 223f4d3dbcb478ecc3e9ecc5199c0ef95064f02e280b694d63feb51465765e3e

See more details on using hashes here.

File details

Details for the file python_barcode-0.13.1-py3-none-any.whl.

File metadata

  • Download URL: python_barcode-0.13.1-py3-none-any.whl
  • Upload date:
  • Size: 217.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for python_barcode-0.13.1-py3-none-any.whl
Algorithm Hash digest
SHA256 daa32fb999a843812fbb1c75ff909638811af7c465f0a991e9e41d26d2a44a24
MD5 1804e2bd778ef88d972eb0ea43694e4b
BLAKE2b-256 4eaa90966e1caf4d630b2bb420084c9eaa14a7d2ddc8e8a4311cd55ac90753a8

See more details on using hashes here.

Supported by

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