python-barcode

https://github.com/whynothugo/python-barcode
Admin
python-barcode is a pure-Python library for generating barcodes in various formats including EAN,...
Tokens:16,389
Snippets:144
Trust Score:8.6
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Installation via pip

Source: https://github.com/whynothugo/python-barcode/blob/main/docs/getting-started.rst

Install python-barcode with pip. The first command installs the core library. The second installs optional image support (e.g., for PNG); keep the quotes because most shells treat square brackets specially.

```shell
pip install python-barcode
```

```shell
pip install "python-barcode[images]"
# Note: keep the quotes, most shells don't play nice with square brackets.
```

--------------------------------

### Command line usage (python-barcode create)

Source: https://github.com/whynothugo/python-barcode/blob/main/docs/getting-started.rst

Command-line usage examples for the python-barcode CLI. Shows creating a barcode, specifying output file and type, and the help output. PNG generation requires Pillow.

```console
$ # Save a barcode to outfile.svg:
$ python-barcode create "123456789000" outfile -b ean --text "text to appear under barcode"
$ # Generate a PNG (Require Pillow):
$ python-barcode create -t png "My Text" outfile
$ python-barcode --help
usage: python-barcode [-h] [-v] {create,list} ...

Create standard barcodes via cli.

optional arguments:
  -h, --help     show this help message and exit
  -v, --version  show program's version number and exit

Actions:
  {create,list}
    create       Create a barcode with the given options.
    list         List available image and code types.

Image output enabled, use --type option to give image format (png, jpeg, ...).
$
```

--------------------------------

### Interactive SVG generation

Source: https://github.com/whynothugo/python-barcode/blob/main/docs/getting-started.rst

Interactive Python session showing how to generate an SVG barcode. It lists available barcode types, gets the EAN13 class, creates an instance, and saves it to a file named ean13_barcode.svg.

```pycon
>>> import barcode
>>> barcode.PROVIDED_BARCODES
['code128', 'code39', 'ean', 'ean13', 'ean14', 'ean8', 'gs1', 'gs1_128', 'gtin', 'isbn', 'isbn10', 'isbn13', 'issn', 'itf', 'jan', 'pzn', 'upc', 'upca']
>>> EAN = barcode.get_barcode_class('ean13')
>>> EAN
<class 'barcode.ean.EuropeanArticleNumber13'>
>>> my_ean = EAN('5901234123457')
>>> my_ean
<EuropeanArticleNumber13('5901234123457')>
>>> fullname = my_ean.save('ean13_barcode')
>>> fullname
'ean13_barcode.svg'
>>>
```

--------------------------------

### Creating compressed SVGs with barcode.save()

Source: https://github.com/whynothugo/python-barcode/blob/main/docs/writers.rst

Shows how to generate an EAN-13 barcode and save it as an SVG, then save a compressed SVGZ by passing a dictionary with `compress=True` to `save()`. The output filenames are `ean13.svg` and `ean13.svgz`.

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

--------------------------------

### Interactive PNG generation and generate() helper

Source: https://github.com/whynothugo/python-barcode/blob/main/docs/getting-started.rst

Interactive Python session showing how to generate a PNG barcode with ImageWriter, save to a file, write to a BytesIO object, and use the generate() function for both SVG and image outputs. Note that write() with ImageWriter produces RAW format, not a standard image.

```pycon
>>> import barcode
>>> from barcode.writer import ImageWriter
>>> EAN = barcode.get_barcode_class('ean13')
>>> my_ean = EAN('5901234123457', writer=ImageWriter())
>>> fullname = my_ean.save('ean13_barcode')
>>> fullname
'ean13_barcode.png'
>>> from io import BytesIO
>>> fp = BytesIO()
>>> my_ean.write(fp)
>>> my_ean
<EuropeanArticleNumber13('5901234123457')>
>>> with open("path/to/file", "wb") as f:
...     my_ean.write(f)  # Pillow (ImageWriter) produces RAW format here
...
>>> from barcode import generate
>>> name = generate('EAN13', '5901234123457', output='barcode_svg')
>>> name
'barcode_svg.svg'
>>> fp = BytesIO()
>>> generate('EAN13', '5901234123457', writer=ImageWriter(), output=fp)
>>>
```

--------------------------------

### Barcode.render()

Source: https://github.com/whynothugo/python-barcode/blob/main/docs/writers.rst

Renders the barcode using the writer's callbacks.

```APIDOC
## [RENDER] Barcode.render()

### Description
Renders the barcode using the writer's callbacks. This method is called on a barcode instance to generate the barcode image.

### Method
RENDER

### Endpoint
Barcode.render()

### Parameters
None

### Request Example
```python
barcode_instance.render()
```
```

--------------------------------

### Writer.set_options(options)

Source: https://github.com/whynothugo/python-barcode/blob/main/docs/writers.rst

Sets the writer options for a barcode writer.

```APIDOC
## [SET_OPTIONS] Writer.set_options(options)

### Description
Sets the writer options for the barcode writer. The options are provided as a dictionary where keys are option names and values are option values.

### Method
SET_OPTIONS

### Endpoint
Writer.set_options(options)

### Parameters
#### Request Body
- **options** (dictionary) - Required - A dictionary of writer options. See Common Writer Options for details.

### Request Example
```python
writer.set_options({'module_width': 0.3, 'module_height': 20.0})
```
```

--------------------------------

### Barcode.save(filename, options)

Source: https://github.com/whynothugo/python-barcode/blob/main/docs/writers.rst

Saves a barcode to a file with configurable writer options.

```APIDOC
## [SAVE] Barcode.save(filename, options)

### Description
Saves the barcode to a file using the specified writer options. The options are passed as keyword arguments to `Barcode.save(filename, options)`.

### Method
SAVE

### Endpoint
Barcode.save(filename, options)

### Parameters
#### Path Parameters
- **filename** (string) - Required - The filename to save the barcode to.

#### Request Body
- **options** (dictionary) - Optional - A dictionary of writer options. See Common Writer Options for details.

### Request Example
```python
options = dict(compress=True)
filename = ean.save('ean13', options)
```

### Response
#### Success Response
- **filename** (string) - The filename of the saved barcode file.

#### Response Example
```python
'ean13.svgz'
```
```

--------------------------------

### Generate image with EAN13

Source: https://github.com/whynothugo/python-barcode/blob/main/docs/getting-started.rst

Generates an EAN-13 barcode as a raster image (e.g., JPEG) using the ImageWriter. Requires the 'images' extras. The documentation warns that SVG is vectorized and scales better; use images only if SVG is not supported.

```python
from io import BytesIO

from barcode import EAN13
from barcode.writer import ImageWriter

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

# Or to an actual file:
with open("somefile.jpeg", "wb") as f:
    EAN13("100000011111", writer=ImageWriter()).write(f)
```

--------------------------------

### Generate SVG with EAN13

Source: https://github.com/whynothugo/python-barcode/blob/main/docs/getting-started.rst

Generates an EAN-13 barcode as SVG using the SVGWriter. It works with file-like objects (BytesIO) and real files. Checksums are computed automatically; the add_checksum option is available for Code 39.

```python
from io import BytesIO

from barcode import EAN13
from barcode.writer import SVGWriter

# Write to a file-like object:
rv = BytesIO()
EAN13("100000902922", writer=SVGWriter()).write(rv)

# Or to an actual file:
with open("somefile.svg", "wb") as f:
    EAN13(str(100000011111), writer=SVGWriter()).write(f)
```
Tokens:
Raw