Skip to main content

Cups label printer plugin for InvenTree

Project description

inventree-cups-plugin

License: MIT CI

A label printer driver plugin for InvenTree, which provides support for Cups label printing servers. If your printer is not cups compatible, you can setup a cups printing server. This article describes how to setup a cups printing server for the DYMO LabelWriter 450 Duo. If you have a Dymo printer, you might also want to check out the dedicated inventree-dymo-plugin which is the recommended choice because it works more performant.

Installation

[!IMPORTANT] This plugin needs cups-devel installed to install its dependencies. You can read more about the requirements at pycups. If you're using apt as a package manager run apt install libcups2-dev before. For docker see below.

[!IMPORTANT] For InvenTree<0.16 use this package with version 0.1.0

Goto "Settings > Plugins > Install Plugin" and enter inventree-cups-plugin as package name.

Docker

For docker installs you need to build your own docker image based on the inventree image to install the required system dependencies. The following Dockerfile is using a multistage build to only install what is needed onto the inventree image and do the building in a separate stage.

[!NOTE] This only works for the inventree alpine based docker image which is shipped with inventree>=0.13.

To use it you have to do some slight modifications of the docker-compose.yml file and create the Dockerfile as follows:

docker-compose.yml changes
diff --git a/docker-compose.yml b/docker-compose.yml
index 8adee63..dc3993c 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -69,7 +69,14 @@ services:
     # Uses gunicorn as the web server
     inventree-server:
         # If you wish to specify a particular InvenTree version, do so here
-        image: inventree/inventree:${INVENTREE_TAG:-stable}
+        image: inventree/inventree:${INVENTREE_TAG:-stable}-printing
+        pull_policy: never
+        build:
+          context: .
+          dockerfile: Dockerfile
+          target: production
+          args:
+            INVENTREE_TAG: ${INVENTREE_TAG:-stable}
         # Only change this port if you understand the stack.
         # If you change this you have to change:
         # - the proxy settings (on two lines)
@@ -88,7 +95,8 @@ services:
     # Background worker process handles long-running or periodic tasks
     inventree-worker:
         # If you wish to specify a particular InvenTree version, do so here
-        image: inventree/inventree:${INVENTREE_TAG:-stable}
+        image: inventree/inventree:${INVENTREE_TAG:-stable}-printing
+        pull_policy: never
         command: invoke worker
         depends_on:
             - inventree-server
Dockerfile
ARG INVENTREE_TAG

# prebuild stage - needs a lot of build dependencies
FROM python:3.10-alpine3.18 as prebuild

RUN apk add --no-cache cups-dev gcc git musl-dev && \
    pip install --user --no-cache-dir git+https://github.com/wolflu05/inventree-cups-plugin

# production image - only install the cups shared library
FROM inventree/inventree:${INVENTREE_TAG} as production

RUN apk add --no-cache cups-libs
COPY --from=prebuild /root/.local /root/.local

Configuration Options

Name Description Example
Server IP/Hostname to connect to the cups server 192.168.1.5
Port Port to connect to the cups server 631
User User to connect to the cups server can also be empty
Password Password to connect to the cups server can also be empty
Printer Printer from cups server, can be selected if valid connection options are set myprinter

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

inventree_cups_plugin-1.0.0.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

inventree_cups_plugin-1.0.0-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file inventree_cups_plugin-1.0.0.tar.gz.

File metadata

  • Download URL: inventree_cups_plugin-1.0.0.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.9

File hashes

Hashes for inventree_cups_plugin-1.0.0.tar.gz
Algorithm Hash digest
SHA256 2c25fa213d025d7e86ec87bfe359c2fb05b6493cae4cbc635c0571a08dc762e1
MD5 22f24bfbfa78b13719f6a18c38459200
BLAKE2b-256 75baae853a0388f4928de2750427d0c9d368d57851a40c06027862b9997e2782

See more details on using hashes here.

File details

Details for the file inventree_cups_plugin-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for inventree_cups_plugin-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a870443cdf1cd511ffa38bdf501aecfd04e2e3ca9b1b4184afd8cba47c6c7a35
MD5 c9703adc49d2e4d7280c3ca29bfd67f9
BLAKE2b-256 b8c8b26faa419281e4a6d208ccc2615410d50afc550139856b20c01464dc3f1d

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