steenzout.barcode’s documentation¶

Contents¶

Introduction¶

This package was created to have barcodes available without having PIL (Python Imaging Library) installed.

As of version 0.4b1 PIL is also supported for creating barcodes.

All you need to create a barcode is to know the system (EAN, UPC, ...) and the code (e.g. for EAN-13: 123456789102).

As you see, you do not need the checksum, it will be calculated automatically.

In some systems (Code 39) the checksum is optional, there you can give the add_checksum keyword argument (default is True).

As of version 0.7beta3 Python 3 is supported, but not well tested.

Creating barcodes as SVG¶

To generate barcodes as SVG objects, you can use the default writer (simply not specify a writer).

Quick example:

>>> from steenzout import barcode
>>> ean = barcode.get('ean13', '123456789102')
# Now we look if the checksum was added
>>> ean.get_fullcode()
u'1234567891026'
>>> filename = ean.save('ean13')
>>> filename
u'ean13.svg'
>>> options = dict(compress=True)
>>> filename = ean.save('ean13', options)
>>> filename
u'ean13.svgz'

Now you have ean13.svg and the compressed ean13.svgz in your current working directory. Open it and see the result.

Creating barcodes as Image¶

New in version 0.4b1.

To generate barcodes as images, you must provide the ImageWriter to the get function.

Without any options, the images are rendered as PNG.

Quick example:

>>> from steenzout import barcode
>>> from steenzout.barcode.writer import ImageWriter
>>> ean = barcode.get('ean13', '123456789102', writer=ImageWriter())
>>> filename = ean.save('ean13')
>>> filename
u'ean13.png'

Command-line interface¶

The install script detects your Python version and adds the major and minor Python version number to the executable script.

For example, on Python 2.7, the command-line interface tool will be py27-barcode.

Commands¶

Usage:

$ py27-barcode --help
Usage: py27-barcode [OPTIONS] COMMAND [ARGS]...

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  encodings  List the available bar codes.
  formats    List the available image formats.
  generate   Generates the bar code.

Generate:

$ py27-barcode generate --help
Usage: py27-barcode generate [OPTIONS] INPUT OUTPUT

  Generates the bar code.

Options:
  -v, --verbose                   Enables verbosity.
  -e, --encoding [code128|code39|ean|ean13|ean8|gs1|gtin|isbn|isbn10|isbn13|issn|jan|pzn|upc|upca]
  -f, --format [BMP|EPS|GIF|JPEG|MSP|PCX|PNG|SVG|TIFF|XBM]
  -u, --unit TEXT
  --help                          Show this message and exit.

The number of output formats available will depend if you installed PIL:

$ pip install steenzout.barcode[image]

Provided barcodes¶

Code 39¶

class Code39(code, writer=None)[source]¶

Initializes a new Code39 instance.

code¶: str

writer¶: writer.BaseWriter – writer class.

Parameters:	code (str) – Code 39 string without * and checksum (added automatically if add_checksum is True). writer (`writer Instance`) – instance of writer class to render the bar code. add_checksum (bool) – add the checksum to code or not.

Code 128¶

New in version 0.8beta1.

class Code128(code, writer=None)[source]¶

Initializes a new Code128 instance. The checksum is added automatically when building the bars.

Parameters:	code (str) – code 128 string without checksum (added automatically). writer (`writer.BaseWriter`) – instance of writer class to render the bar code.

PZN¶

class PZN(code, writer=None)[source]¶

Initializes new German number for pharmaceutical products.

Parameters:	pzn (str) – code to render. writer (`writer.BaseWriter`) – instance of writer class to render the bar code.

EAN-13¶

EuropeanArticleNumber13¶: alias of EAN13

EAN-8¶

EuropeanArticleNumber8¶: alias of EAN8

JAN¶

JapanArticleNumber¶: alias of JAN

ISBN-13¶

InternationalStandardBookNumber13¶: alias of ISBN13

ISBN-10¶

InternationalStandardBookNumber10¶: alias of ISBN10

ISSN¶

InternationalStandardSerialNumber¶: alias of ISSN

UPC-A¶

UniversalProductCodeA¶: alias of UPCA

Writer¶

Common Writer Options¶

All writer take the following options (specified as keyword arguments to Barcode.save(filename, option=value) or set via Writer.set_options(option=value)).

Note

See the documentation of the specific writer for special options, only available for this writer.

Common Options:¶

module_width:	The width of one barcode module in mm as float. Defaults to 0.2.
module_height:	The height of the barcode modules in mm as float. Defaults to 15.0.
quiet_zone:	Distance on the left and on the right from the border to the first (last) barcode module in mm as float. Defaults to 6.5.
font_size:	Font size of the text under the barcode in pt as integer. Defaults to 10.
text_distance:	Distance between the barcode and the text under it in mm as float. Defaults to 5.0.
background:	The background color of the created barcode as string. Defaults to white.
foreground:	The foreground and text color of the created barcode as string. Defaults to black.

New in version 0.6.

center_text:	If true (the default) the text is centered under the barcode else left aligned.

Note

Some barcode classes change the above defaults to fit in some kind of specification.

Writers¶

SVGWriter¶

Creates barcodes as (compressed) SVG objects.

Special Options¶

In addition to the common writer options you can give the following special option.

Special Option:¶

compress:	Boolean value to output a compressed SVG object (.svgz). Defaults to False.

ImageWriter¶

New in version 0.4b1.

Creates barcodes as image. All imagetypes supported by PIL are availble.

Special Options¶

In addition to the common writer options you can give the following special options.

Special Options:¶

format:	The image file format as string. All formats supported by PIL are valid (e.g. PNG, JPEG, BMP, ...). Defaults to PNG.
dpi:	DPI as integer to calculate the image size in pixel. This value is used for all mm to px calculations. Defaults to 300.

Create your own writer¶

To create your own writer, inherit from steenzout.barcode.writer.BaseWriter.

In your __init__ method call BaseWriter’s __init__ and give your callbacks for initialize(raw_code), paint_module(xpos, ypos, width, color), paint_text(xpos, ypos) and finish().

Now instantiate a new barcode and give an instance of your new writer as argument.

If you now call render on the barcode instance your callbacks get called.

API (autogenerated)¶

class Base(initialize=None, paint_module=None, paint_text=None, finish=None)[source]¶

Base class for all writers.

Initializes the basic writer options. Sub-classes can add more attributes and can set them directly or using self.set_options(option=value).

Parameters:

initialize (function) – Callback for initializing the inheriting writer. Is called: callback_initialize(raw_code)
paint_module (function) – Callback for painting one barcode module. Is called: callback_paint_module(xpos, ypos, width, color)
paint_text (function) – Callback for painting the text under the barcode. Is called: callback_paint_text(xpos, ypos) using self.text as text.
finish (function) – Callback for doing something with the completely rendered output. Is called: return callback_finish() and must return the rendered output.

calculate_size(modules_per_line, number_of_lines, dpi=300)[source]¶

Calculates the size of the barcode in pixel.

Parameters:	modules_per_line (int) – number of modules in one line. number_of_lines (int) – number of lines of the barcode. dpi (int) – DPI to calculate.
Returns:	Width and height of the barcode in pixel.
Return type:	(tuple[int, int])

register_callback(action, callback)[source]¶

Register one of the three callbacks if not given at instance creation.

Parameters:	action (str) – One of ‘initialize’, ‘paint_module’, ‘paint_text’, ‘finish’. callback (function) – The callback function for the given action.

render(code)[source]¶

Renders the barcode to whatever the inheriting writer provides, using the registered callbacks.

Parameters:	code (list[str]) – list of strings matching the writer spec (only contain 0 or 1).

save(filename, output)[source]¶: See Interface.save().

set_options(options)[source]¶

Sets the given options as instance attributes (only if they are known).

Parameters:	options (dict) – All known instance attributes and more if the child class has defined them before this call.

class Interface[source]¶

Writer interface.

save(filename, content)[source]¶

Saves contents to filename.

Parameters:	filename (str) – filename without extension. content (str) – output of rendering process.
Returns:	the filename.
Return type:	(str)

create_svg_object()[source]¶

Returns a blank SVG document.

Returns:	XML document.
Return type:	(`xml.dom.minidom.DocumentType`)

mm2px(value, dpi=300)[source]¶

Converts the given value in millimeters into dots per inch.

Parameters:	value (float) – value, in millimeters. dpi (int) – resolution, in dots per inch.
Returns:	value, in dots per inch.
Return type:	(float)

pt2mm(value)[source]¶

Converts given value in points to millimeters.

Parameters:	value (int) – value in points.
Returns:	value, in millimeters.
Return type:	(float)

License¶

This package is distributed under the MIT license:

Copyright (c) 2010-2013 Thorsten Weimann
Copyright (c) 2014 Alexander Shorin
Copyright (c) 2016 Pedro Salgado

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Indices and tables¶

Search Page

Latest version¶

You can always download the latest release here.

API documentation¶

This section contains information on a specific function, class, or method.

steenzout package¶

Subpackages¶

steenzout.barcode package¶

Subpackages¶

steenzout.barcode.charsets package¶

Submodules¶

steenzout.barcode.charsets.code128 module¶

Code 128 character sets.

steenzout.barcode.charsets.code39 module¶

Code 39 character sets.

steenzout.barcode.charsets.ean module¶

EAN character sets.

steenzout.barcode.charsets.upc module¶

UPC character sets.

Module contents¶

Character sets package.

steenzout.barcode.cli package¶

Module contents¶

Command-line tool package.

Submodules¶

steenzout.barcode.base module¶

Base bar code module.

class Barcode(code, writer=None)[source]¶

Bases: steenzout.object.Object

Base bar code class.

build()[source]¶

Returns:
Return type:	(str)

classmethod calculate_checksum(code)[source]¶

Calculates a bar code checksum.

Parameters:	code (str) – the code.
Returns:	the checksum.
Return type:	(integer)

checksum¶: (int) – bar code checksum.

code¶: (str) – bar code.

digits = 0¶

get_fullcode()[source]¶

Returns the full code, encoded in the barcode.

Returns:	Full human readable code.
Return type:	(str)

name = ''¶

raw = None¶

render(writer_options=None)[source]¶

Renders the barcode using self.writer.

Parameters:	writer_options (dict) – options for self.writer, see writer docs for details.
Returns:	output of the writer’s render method.

save(filename, options=None)[source]¶

Renders the barcode and saves it in filename.

Parameters:	filename (str) – filename to save the barcode in (without filename extension). options (dict) – the same as in :py:func:`self.render.
Returns:	Filename with extension.
Return type:	(str)

to_ascii()[source]¶

Returns ASCII representation of the bar code.

Returns:	ASCII representation of the bar code.
Return type:	(str)

classmethod validate(code)[source]¶: Validates the given bar code.

write(fp, options=None)[source]¶

Renders the barcode and writes it to the file like object fp.

Parameters:	fp – File like object object to write the raw data in. options (dict) – the same as in :py:func:`self.render.

writer¶: (steenzout.barcode.writer.Interface) – writer instance.

steenzout.barcode.codex module¶

Module: barcode.codex

Provided barcodes:
	Code 39, Code 128, PZN

class Code128(code, writer=None)[source]¶

Bases: steenzout.barcode.base.Barcode

Initializes a new Code128 instance. The checksum is added automatically when building the bars.

Parameters:	code (str) – code 128 string without checksum (added automatically). writer (`writer.BaseWriter`) – instance of writer class to render the bar code.

build()[source]¶

static calculate_checksum(code)[source]¶

encoded¶

get_fullcode()[source]¶

name = 'Code 128'¶

render(writer_options=None)[source]¶

static validate(code)[source]¶

class Code39(code, writer=None)[source]¶

Bases: steenzout.barcode.base.Barcode

Initializes a new Code39 instance.

code¶: str

writer¶: writer.BaseWriter – writer class.

Parameters:	code (str) – Code 39 string without * and checksum (added automatically if add_checksum is True). writer (`writer Instance`) – instance of writer class to render the bar code. add_checksum (bool) – add the checksum to code or not.

build()[source]¶

static calculate_checksum(code)[source]¶

get_fullcode()[source]¶

name = 'Code 39'¶

render(writer_options=None)[source]¶

static validate(code)[source]¶

class PZN(code, writer=None)[source]¶

Bases: steenzout.barcode.codex.Code39

Initializes new German number for pharmaceutical products.

Parameters:	pzn (str) – code to render. writer (`writer.BaseWriter`) – instance of writer class to render the bar code.

build()[source]¶

static calculate_checksum(code)[source]¶

code39()[source]¶

digits = 6¶

get_fullcode()[source]¶

name = 'Pharmazentralnummer'¶

static validate(code)[source]¶

check_code(code, name, allowed)[source]¶

steenzout.barcode.ean module¶

Module: barcode.ean

Provided barcodes:
	EAN-13, EAN-8, JAN

class EAN13(code, writer=None)[source]¶

Bases: steenzout.barcode.base.Barcode

Class for EAN13 bar codes.

checksum¶: int – EAN checksum.

Parameters:	ean (str) – the EAN number. writer (`writer.BaseWriter`) – instance of writer class to render the bar code.

build()[source]¶

Builds the barcode pattern from self.ean.

Returns:	The pattern as string.
Return type:	(str)

static calculate_checksum(code)[source]¶

Calculates a EAN-13 code checksum.

Parameters:	code (str) – EAN-13 code.
Returns:	the checksum for self.ean.
Return type:	(integer)

digits = 13¶

get_fullcode()[source]¶

name = 'EAN-13'¶

render(writer_options=None)[source]¶

to_ascii()[source]¶

Returns an ascii representation of the barcode.

Returns:	ascii representation of the barcode.
Return type:	(str)

static validate(code)[source]¶

Calculates a EAN-13 code checksum.

Parameters:	code (str) – EAN-13 code.
Raises:	IllegalCharacterError in case the bar code contains illegal characters. ValueError in case the bar code exceeds its maximum length or – if the checksum digit doesn’t match.

class EAN8(code, writer=None)[source]¶

Bases: steenzout.barcode.ean.EAN13

Class for EAN-8 bar codes.

See EAN-13 for details.

Parameters:	code (str): EAN-8 number. writer (`writer.BaseWriter`): instance of writer class to render the bar code.

build()[source]¶

Builds the barcode pattern from self.ean.

Returns:	string representation of the pattern.
Return type:	(str)

static calculate_checksum(code)[source]¶

Calculates an EAN-8 code checksum.

Parameters:	code (str) – EAN-8 code.
Returns:	EAN checksum.
Return type:	(int)

digits = 8¶

name = 'EAN-8'¶

static validate(code)[source]¶

Calculates a EAN-8 code checksum.

Parameters:	code (str) – EAN-8 code.
Raises:	IllegalCharacterError in case the bar code contains illegal characters. ValueError in case the bar code exceeds its maximum length or – if the checksum digit doesn’t match..

EuropeanArticleNumber13¶: alias of EAN13

EuropeanArticleNumber8¶: alias of EAN8

class JAN(code, writer=None)[source]¶

Bases: steenzout.barcode.ean.EAN13

Class for JAN bar codes.

Parameters:	code (str) – the jan number. writer (`writer.BaseWriter`) – instance of writer class to render the bar code.

name = 'JAN'¶

valid_country_codes = [450, 451, 452, 453, 454, 455, 456, 457, 458, 459, 490, 491, 492, 493, 494, 495, 496, 497, 498, 499]¶

JapanArticleNumber¶: alias of JAN

steenzout.barcode.errors module¶

Exceptions module.

exception BarcodeError(msg)[source]¶

Bases: exceptions.Exception

Base class for steenzout.barcode exceptions.

exception BarcodeNotFoundError(name)[source]¶

Bases: steenzout.barcode.errors.BarcodeError

Raised when an unknown barcode is requested.

exception IllegalCharacterError(allowed)[source]¶

Bases: steenzout.barcode.errors.BarcodeError

Raised when a bar code contains illegal characters.

exception NumberOfDigitsError(msg)[source]¶

Bases: steenzout.barcode.errors.BarcodeError

Raised when the number of digits do not match.

exception WrongCountryCodeError(country)[source]¶

Bases: steenzout.barcode.errors.BarcodeError

Raised when a JAN (Japan Article Number) doesn’t start with 450-459 or 490-499.

steenzout.barcode.factory module¶

Factory module.

create_instance(name, code, writer=None)[source]¶

Return bar code instance.

Parameters:	name (str) – bar code name. code (str) – code text. writer (`steenzout.barcode.writer.Interface`) – writer instance.
Raises:	(`BarcodeNotFoundError`) – when the bar code encoding name is invalid or the encoding is not implemented.
Returns:	bar code instance.
Return type:	(`steenzout.barcode.base.Base`)

steenzout.barcode.helpers module¶

Helpers module.

sum_chars(char, other)[source]¶

Sum the value of two string characters.

Parameters:	char (char) – string of the integer. other (char) – string of the integer.
Returns:	sum of the integer value of x and integer value of y.
Return type:	(int)

steenzout.barcode.isxn module¶

ISXN module.

Provided barcodes:
	ISBN-13, ISBN-10, ISSN

This module provides some special codes, which are no standalone bar codes.

All codes where transformed to EAN-13 barcodes.

In every case, the checksum is new calculated.

Example:

>>> from steenzout.barcode import get_barcode
>>> ISBN = get_barcode('isbn10')
>>> isbn = ISBN('0132354187')
>>> unicode(isbn)
u'0132354187'
>>> isbn.get_fullcode()
u'9780132354189'
>>> # Test with wrong checksum
>>> isbn = ISBN('0132354180')
>>> unicode(isbn)
u'0132354187'

class ISBN10(code, writer=None)[source]¶

Bases: steenzout.barcode.isxn.ISBN13

Class for ISBN-10 bar codes.

Parameters:	code (str) – ISBN number. writer (`writer.BaseWriter`) – instance of writer class to render the bar code.

static calculate_checksum(code)[source]¶

digits = 10¶

ean13()[source]¶

Returns the EAN-13 representation of the ISBN-10 bar code.

Returns:	EAN-13 representation of the bar code.
Return type:	(`EAN13`)

isbn13()[source]¶

Returns the ISBN-13 representation of the ISBN-10 bar code.

Returns:	ISBN-13 representation of the bar code.
Return type:	(`ISBN13`)

name = 'ISBN-10'¶

static validate(code)[source]¶

class ISBN13(isbn, writer=None)[source]¶

Bases: steenzout.barcode.ean.EAN13

Class for ISBN-13 bar codes.

Parameters:	isbn (str) – ISBN number. writer (`writer.BaseWriter`) – instance of writer class to render the bar code.

static calculate_checksum(code)[source]¶

digits = 13¶

name = 'ISBN-13'¶

static validate(code)[source]¶

class ISSN(issn, writer=None)[source]¶

Bases: steenzout.barcode.ean.EAN13

Class for ISSN bar codes.

This code is rendered as EAN-13 by prefixing it with 977 and adding 00 between code and checksum.

Parameters:	issn (str) – issn number. writer (`writer.BaseWriter`) – instance of writer class to render the bar code.

build()[source]¶

Builds the barcode pattern from self.ean.

Returns:	The pattern as string.
Return type:	(str)

static calculate_checksum(code)[source]¶

digits = 8¶

ean13()[source]¶

Returns the EAN-13 representation of the ISSN bar code.

Returns:	EAN-13 representation of the bar code.
Return type:	(`EAN13`)

name = 'ISSN'¶

static validate(code)[source]¶

InternationalStandardBookNumber10¶: alias of ISBN10

InternationalStandardBookNumber13¶: alias of ISBN13

InternationalStandardSerialNumber¶: alias of ISSN

steenzout.barcode.metadata module¶

Metadata module.

steenzout.barcode.upc module¶

UPC module.

Provided barcodes:
	UPC-A

class UPCA(code, writer=None)[source]¶

Bases: steenzout.barcode.base.Barcode

Class for UPC-A bar codes.

Parameters:	code (str) – UPC-A bar code. writer (`writer.BaseWriter`) – instance of writer class to render the bar code.

build()[source]¶

Builds the bar code pattern.

Returns:	the bar code pattern.
Return type:	(str)

static calculate_checksum(code)[source]¶

Calculates the UPC-A checksum.

Parameters:	code (str) – UPC-A code.
Returns:	UPC-A checksum.
Return type:	(int)

digits = 12¶

get_fullcode()[source]¶

name = 'UPC-A'¶

render(writer_options=None)[source]¶

to_ascii()[source]¶

Returns an ASCII representation of the bar code.

Returns:	ASCII representation of the bar code.
Return type:	(str)

static validate(code)[source]¶

Calculates a UPC-A code checksum.

Parameters:	code (str) – UPC-A code.
Raises:	IllegalCharacterError in case the bar code contains illegal characters. ValueError in case the bar code exceeds its maximum length or – if the checksum digit doesn’t match.

UniversalProductCodeA¶: alias of UPCA

steenzout.barcode.writer module¶

class Base(initialize=None, paint_module=None, paint_text=None, finish=None)[source]¶

Bases: steenzout.object.Object, steenzout.barcode.writer.Interface

Base class for all writers.

Initializes the basic writer options. Sub-classes can add more attributes and can set them directly or using self.set_options(option=value).

Parameters:

initialize (function) – Callback for initializing the inheriting writer. Is called: callback_initialize(raw_code)
paint_module (function) – Callback for painting one barcode module. Is called: callback_paint_module(xpos, ypos, width, color)
paint_text (function) – Callback for painting the text under the barcode. Is called: callback_paint_text(xpos, ypos) using self.text as text.
finish (function) – Callback for doing something with the completely rendered output. Is called: return callback_finish() and must return the rendered output.

calculate_size(modules_per_line, number_of_lines, dpi=300)[source]¶

Calculates the size of the barcode in pixel.

Parameters:	modules_per_line (int) – number of modules in one line. number_of_lines (int) – number of lines of the barcode. dpi (int) – DPI to calculate.
Returns:	Width and height of the barcode in pixel.
Return type:	(tuple[int, int])

register_callback(action, callback)[source]¶

Register one of the three callbacks if not given at instance creation.

Parameters:	action (str) – One of ‘initialize’, ‘paint_module’, ‘paint_text’, ‘finish’. callback (function) – The callback function for the given action.

render(code)[source]¶

Renders the barcode to whatever the inheriting writer provides, using the registered callbacks.

Parameters:	code (list[str]) – list of strings matching the writer spec (only contain 0 or 1).

save(filename, output)[source]¶: See Interface.save().

set_options(options)[source]¶

Sets the given options as instance attributes (only if they are known).

Parameters:	options (dict) – All known instance attributes and more if the child class has defined them before this call.

DEFAULT_WRITER¶: alias of SVG

class ImageWriter[source]¶

Bases: steenzout.barcode.writer.Base

save(filename, output)[source]¶: See Interface.save().

class Interface[source]¶

Bases: object

Writer interface.

save(filename, content)[source]¶

Saves contents to filename.

Parameters:	filename (str) – filename without extension. content (str) – output of rendering process.
Returns:	the filename.
Return type:	(str)

class SVG[source]¶

Bases: steenzout.barcode.writer.Base

save(filename, content)[source]¶: See Interface.save().

create_svg_object()[source]¶

Returns a blank SVG document.

Returns:	XML document.
Return type:	(`xml.dom.minidom.DocumentType`)

mm2px(value, dpi=300)[source]¶

Converts the given value in millimeters into dots per inch.

Parameters:	value (float) – value, in millimeters. dpi (int) – resolution, in dots per inch.
Returns:	value, in dots per inch.
Return type:	(float)

pt2mm(value)[source]¶

Converts given value in points to millimeters.

Parameters:	value (int) – value in points.
Returns:	value, in millimeters.
Return type:	(float)

Module contents¶

This package provides a simple way to create standard bar codes.

It needs no external packages to be installed, the bar codes are created as SVG objects.

If PIL (Python Imaging Library) is installed, the bar codes can also be rendered as images (all formats supported by PIL).

encodings()[source]¶

Return bar code encodings available.

Returns:	available bar code encodings.
Return type:	(list[str])

formats()[source]¶

Return image formats available.

Returns:	available image formats.
Return type:	(list[‘str’])

generate(name, code, writer=None, output=None, writer_options=None)[source]¶

Generates a file containing an image of the bar code.

Parameters:	name (str) – bar code name. code (str) – bar code. writer (`steenzout.barcode.writer.Interface`) – writer instance. output (str) – filename of output. writer_options (dict) – options for the writer class.
Raises:	(`BarcodeNotFoundError`) – when the bar code encoding name is invalid or the encoding is not implemented.

version()[source]¶

Returns package version.

Returns:	package version.
Return type:	(str)

Module contents¶

steenzout namespace package.

Project page:	https://github.com/steenzout/python-barcode/
Issues:	https://github.com/steenzout/python-barcode/issues/

steenzout.barcode’s documentation¶

Contents¶

Introduction¶

Creating barcodes as SVG¶

Creating barcodes as Image¶

Command-line interface¶

Commands¶

Provided barcodes¶

Code 39¶

Code 128¶

PZN¶

EAN-13¶

EAN-8¶

JAN¶

ISBN-13¶

ISBN-10¶

ISSN¶

UPC-A¶

Writer¶

Common Writer Options¶

Common Options:¶

Writers¶

SVGWriter¶

Special Options¶

ImageWriter¶

Special Options¶

Create your own writer¶

API (autogenerated)¶

License¶

Indices and tables¶

Latest version¶

Related Links¶

API documentation¶

steenzout package¶

Subpackages¶

steenzout.barcode package¶

Subpackages¶

steenzout.barcode.charsets package¶

steenzout.barcode.cli package¶

Submodules¶

steenzout.barcode.base module¶

steenzout.barcode.codex module¶

steenzout.barcode.ean module¶

steenzout.barcode.errors module¶

steenzout.barcode.factory module¶

steenzout.barcode.helpers module¶

steenzout.barcode.isxn module¶

steenzout.barcode.metadata module¶

steenzout.barcode.upc module¶

steenzout.barcode.writer module¶

Module contents¶

Module contents¶