Skip to content

README.md

Latest commit

 

History

History
273 lines (188 loc) · 7.33 KB

README.md

File metadata and controls

273 lines (188 loc) · 7.33 KB

Labelle

GitHub Actions (Tests) PyPI version pre-commit.ci status

logo

Open-source label printing software

Features

  • Text printing
  • QR code printing
  • Barcode printing
  • Image printing
  • Combinations of the above
  • GUI Application based on PyQt6
  • Windows support by setting the driver to WinUSB using Zadig

Supported devices

  • DYMO LabelManager PC
  • DYMO LabelPoint 350
  • DYMO LabelManager 280
  • DYMO LabelManager 420P
  • DYMO LabelManager Wireless PnP

Labelle is not affiliated with DYMO. Please see the disclaimer below.

For more information about experimental device support, see #4.

Installation

It is recommended to install Labelle with pipx so that it runs in an isolated virtual environment:

pipx install labelle

In case pipx is not already installed, it can be installed on Ubuntu/Debian with

sudo apt-get install pipx

or on Arch with

sudo pacman -S python-pipx

By default, users don't have permission to access generic USB devices, so you will need to add a rule. The first time you run labelle, it will give instructions about how to do this:

$ labelle "Hello world"
...
You do not have sufficient access to the device. You probably want to add the a udev rule in /etc/udev/rules.d with the following command:

  echo 'ACTION=="add", SUBSYSTEMS=="usb", ATTRS{idVendor}=="0922", ATTRS{idProduct}=="1001", MODE="0666"' | sudo tee /etc/udev/rules.d/91-labelle-1001.rules
...

Testing experimental features

To install a test branch, by GitHub user ghuser for the branch branchname, run

pipx install --force git+https://github.com/ghuser/labelle@branchname

To revert back to the release version, run

pipx install --force labelle

To install a particular release version, specify labelle==x.y.z in place of labelle in the above command.

Development and code style

To install for development, fork and clone this repository, and run (ideally within a venv):

pip install --editable .

This project uses pre-commit to run some checks before committing. After installing the pre-commit executable, please run

pre-commit install

Font management

Default fonts are managed via labelle.ini. This should be placed in your config folder (normally ~/.config). An example file is provided here.

For my Arch-Linux System, fonts are located at e.g.

/usr/share/fonts/TTF/DejaVuSerif.ttf

It is also possible to Download a font from http://font.ubuntu.com/ and use it.

For font discovery, Labelle contains code excerpts from matplotlib. See here for more information and LICENSE for the license.

Labelle includes the Carlito font, licensed under the SIL Open Font License.

Modes

Overview

For a comprehensive list of options, run

labelle --help

Preview

To save tape, you can preview the label without printing it

labelle --output=console --text Hi

Hi

Text

If your text includes whitespace or any other characters like < or $ that are interpreted by your shell, then the text must be quoted.

labelle --text 'Price: $3.50'

Price: $3.50

Multiple text arguments will stack on top of each other as separate lines

labelle --text "first line" --text "second line"

first line second line

Print Codes and Text

Just add a text after your qr or barcode text

labelle --qr "QR Content" --text "Cleartext printed"

QR Content Cleartext printed

Picture printing

Any commonly-supported raster image may be printed.

labelle --picture labelle.png

labelle.png

GUI

Run Labelle GUI

labelle-gui

GUI App Features

  • Live preview
  • margin settings
  • type size selector
  • visualization of tape color schema
  • the ability to freely arrange the content using the "Node" list
    • Text Node:
      • payload text - can be multi-line
      • font selector
      • font scaling - the percentage of line-height
      • frame border width steering
    • Qr Node:
      • payload text
    • BarCode Node:
      • payload text
      • codding selector
    • Image Node:
      • path to file

Nodes can be freely arranged, simply drag&drop rows on the list. To add or delete the node from the label - right-click on the list and select the action from the context menu. To print - click the print button.

Example

Example 1: multiple text + QR code

alt

Example 2: two images + text with frame, white on red

alt

Example 3: barcode with text, text, image

alt

About the name

The name "Labelle" is a multilingual pun by @claui.

Language Word/Interpretation Meaning Pronunciation (IPA) Simplified Phonetic Spelling
English Label A printed sticker /ˈleɪbəl/ LAY-buhl
French La belle The beautiful /la bɛl/ lah BEL
German Libelle (sounds like) Dragonfly /liˈbɛlə/ lee-BELL-uh

Disclaimers

  • This software is provided as-is, without any warranty. Please see LICENSE for details.
  • Labelle is not affiliated, associated, authorized, endorsed by, or in any way officially connected with DYMO, or any of its subsidiaries or its affiliates. The official DYMO website can be found at www.dymo.com. The name DYMO®, as well as related names, marks, emblems, and images, are registered trademarks of their respective owners. Currently, Labelle software is designed to support certain devices manufactured by DYMO; however, no endorsement or partnership is implied.