labeljetty 0.1.0b1__tar.gz

labeljetty-0.1.0b1/.dockerignore

@@ -0,0 +1,20 @@
+# Keep the build context small and reproducible.
+.git
+.github
+.venv
+.pytest_cache
+__pycache__/
+*.pyc
+dist/
+build/
+*.egg-info/
+.coverage
+htmlcov/
+tests/
+scratchpad_code/
+docs/*
+!docs/README.pypi.md
+images/
+*.sqlite
+.env
+src/labeljetty/_version.py

labeljetty-0.1.0b1/.github/workflows/docker-dev.yml

@@ -0,0 +1,46 @@
+name: docker-dev
+
+# Bleeding-edge channel: rebuilds the :dev image on every push to main.
+# x86-only (linux/amd64) — no QEMU, so it's fast; the released images
+# (docker.yml) are the multi-arch ones. Not for production.
+#
+# Required repository secrets (same as docker.yml):
+#   DOCKERHUB_USERNAME  Docker Hub login (needs push access to motey/labeljetty)
+#   DOCKERHUB_TOKEN     Docker Hub access token
+on:
+  push:
+    branches: [main]
+
+jobs:
+  docker-dev:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Compute dev version
+        id: meta
+        env:
+          SHA: ${{ github.sha }}
+        run: |
+          # PEP440-valid local version stamped into the image (LABELJETTY_VERSION).
+          echo "version=0.0.0+dev.${SHA::7}" >> "$GITHUB_OUTPUT"
+
+      - uses: docker/setup-buildx-action@v4
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v4
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v7
+        with:
+          context: .
+          push: true
+          platforms: linux/amd64
+          build-args: |
+            VERSION=${{ steps.meta.outputs.version }}
+          tags: motey/labeljetty:dev
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

labeljetty-0.1.0b1/.github/workflows/docker.yml

@@ -0,0 +1,67 @@
+name: docker
+
+# Builds and pushes the Docker image on a GitHub Release.
+#   - every release  -> :<version>  (e.g. :0.1.0)
+#   - normal release -> :latest
+#   - pre-release    -> :beta
+#
+# Required repository secrets:
+#   DOCKERHUB_USERNAME  Docker Hub login (needs push access to motey/labeljetty)
+#   DOCKERHUB_TOKEN     Docker Hub access token (Account Settings -> Security)
+on:
+  release:
+    types: [published]
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Compute version and tags
+        id: meta
+        env:
+          TAG_NAME: ${{ github.event.release.tag_name }}
+          PRERELEASE: ${{ github.event.release.prerelease }}
+          IMAGE: motey/labeljetty
+        run: |
+          VERSION="${TAG_NAME#v}"
+          TAGS="${IMAGE}:${VERSION}"
+          if [ "${PRERELEASE}" = "true" ]; then
+            TAGS="${TAGS},${IMAGE}:beta"
+          else
+            TAGS="${TAGS},${IMAGE}:latest"
+          fi
+          echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
+          echo "tags=${TAGS}" >> "$GITHUB_OUTPUT"
+
+      - uses: docker/setup-qemu-action@v4
+      - uses: docker/setup-buildx-action@v4
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v4
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v7
+        with:
+          context: .
+          push: true
+          platforms: linux/amd64,linux/arm64
+          build-args: |
+            VERSION=${{ steps.meta.outputs.version }}
+          tags: ${{ steps.meta.outputs.tags }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+      # Push the slim Docker Hub overview/README (links back to GitHub for full docs).
+      - name: Update Docker Hub description
+        uses: peter-evans/dockerhub-description@v4
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+          repository: motey/labeljetty
+          short-description: "Network-accessible printing for USB TSPL thermal label printers (web UI + REST API)."
+          readme-filepath: ./docs/README.docker.md

labeljetty-0.1.0b1/.github/workflows/pypi.yml

@@ -0,0 +1,28 @@
+name: pypi
+
+# Builds and publishes the Python package to PyPI on a GitHub Release.
+# The version is derived from the git tag by hatch-vcs, so the tag (e.g. 0.1.0)
+# IS the published version — fetch full history so the tag is visible.
+#
+# Required repository secret:
+#   PYPI_API_TOKEN  PyPI API token (https://pypi.org/manage/account/token/)
+on:
+  release:
+    types: [published]
+
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Build sdist + wheel
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish --token "${{ secrets.PYPI_API_TOKEN }}"

labeljetty-0.1.0b1/.github/workflows/tests.yml

@@ -0,0 +1,38 @@
+name: tests
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v6
+
+      # Text/markdown rendering uses DejaVu Sans (DEFAULT_FONT_PATH); the runner
+      # does not ship it by default.
+      - name: Install DejaVu fonts
+        run: sudo apt-get update && sudo apt-get install -y --no-install-recommends fonts-dejavu-core
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install project + dev dependencies
+        run: uv sync --group dev --python ${{ matrix.python-version }}
+
+      - name: Run tests
+        # The suite is fully isolated (no .env, no USB, no network) — nothing
+        # extra to configure. "hardware"-marked tests are deselected by default.
+        run: uv run --no-sync python -m pytest --cov=labeljetty --cov-report=term-missing

labeljetty-0.1.0b1/.gitignore

@@ -0,0 +1,214 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+# hatch-vcs writes this at build time from the git tag (see pyproject.toml).
+src/labeljetty/_version.py
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# labeljetty runtime artifacts
+printjobs.sqlite
+*.sqlite
+/images/

labeljetty-0.1.0b1/.python-version

@@ -0,0 +1 @@
+3.11

labeljetty-0.1.0b1/Dockerfile

@@ -0,0 +1,54 @@
+# syntax=docker/dockerfile:1
+
+FROM python:3.11-slim
+
+# VERSION is the release being built (the git tag, e.g. "0.1.0"). It is:
+#  - given to setuptools_scm so the package builds without a .git checkout, and
+#  - exposed at runtime as LABELJETTY_VERSION so the app/API/UI report the release
+#    (see labeljetty/version.py).
+ARG VERSION=0.0.0
+ENV SETUPTOOLS_SCM_PRETEND_VERSION=${VERSION} \
+    LABELJETTY_VERSION=${VERSION} \
+    PYTHONUNBUFFERED=1 \
+    UV_COMPILE_BYTECODE=1 \
+    UV_LINK_MODE=copy
+
+# Runtime system deps:
+#  - libusb-1.0-0: required by pyusb to talk to the USB printer
+#  - fonts-dejavu-core: text/markdown rendering uses DejaVu Sans (DEFAULT_FONT_PATH)
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends \
+        libusb-1.0-0 \
+        fonts-dejavu-core \
+    && rm -rf /var/lib/apt/lists/*
+
+# uv: the official static binary from Astral's image.
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /usr/local/bin/uv
+
+WORKDIR /app
+
+# Install into a project venv from the frozen lockfile. The source is needed
+# because the project itself is installed (and version-stamped) — copy it all.
+# pyproject's `readme` points at docs/README.pypi.md, so that file must be present
+# at its original path for the build to succeed.
+COPY pyproject.toml uv.lock ./
+COPY docs/README.pypi.md ./docs/README.pypi.md
+COPY src ./src
+RUN uv sync --frozen --no-dev --no-editable
+
+ENV PATH="/app/.venv/bin:$PATH"
+
+# Container-friendly defaults (override via env/-e). Data lives under /data so it
+# can be a mounted volume; bind to all interfaces inside the container.
+ENV SERVER_LISTENING_HOST=0.0.0.0 \
+    SERVER_LISTENING_PORT=8888 \
+    SQLITE_PATH=/data/printjobs.sqlite \
+    IMAGE_STORAGE_DIRECTORY=/data/images
+
+RUN mkdir -p /data
+VOLUME ["/data"]
+EXPOSE 8888
+
+# PRINTER_USB has no default and must be provided at run time, e.g.:
+#   docker run --device=/dev/bus/usb -e PRINTER_USB=vid:2d37:pid:62de ...
+ENTRYPOINT ["labeljetty"]

labeljetty-0.1.0b1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tim
+
+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.

labeljetty-0.1.0b1/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: labeljetty
+Version: 0.1.0b1
+Summary: Network-accessible printing for USB TSPL thermal label printers (library + REST API + web UI).
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: fastapi>=0.124.0
+Requires-Dist: getenv>=0.2.0
+Requires-Dist: getversion>=1.0.2
+Requires-Dist: itsdangerous>=2.2.0
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: pillow>=11.3.0
+Requires-Dist: psutil>=7.1.3
+Requires-Dist: pydantic-settings>=2.12.0
+Requires-Dist: pypdfium2>=4.30.0
+Requires-Dist: pyserial>=3.5
+Requires-Dist: python-barcode>=0.15.1
+Requires-Dist: python-multipart>=0.0.20
+Requires-Dist: pyusb>=1.3.1
+Requires-Dist: segno>=1.6.0
+Requires-Dist: sqlmodel>=0.0.27
+Requires-Dist: uvicorn>=0.38.0
+Description-Content-Type: text/markdown
+
+# 🏷️ LabelJetty
+
+**Turn a cheap, USB-only TSPL thermal label printer into a smart, network-accessible label
+printer** - drive it from your phone, desktop, or another machine over your LAN. It talks to the
+printer **directly over USB** (no CUPS, no vendor driver) and gives you a mobile-first web UI, a
+REST API, and a Python library for printing PNGs, PDFs, text, markdown, barcodes and QR codes.
+Optional, self-contained [Homebox](https://github.com/sysadminsmedia/homebox) integration is
+built in.
+
+## Install
+
+```sh
+pip install labeljetty
+# or, with uv:
+uv tool install labeljetty
+```
+
+This gives you three commands:
+
+- `labeljetty` - runs the service (REST API + web UI + background print worker)
+- `labeljetty-testbench` - drives the printer library directly (real device or dry-run)
+- `labeljetty-hash-password` - generates a password hash for a login user
+
+You need **Python 3.11+**, **libusb**, and a USB **TSPL** printer. Set at least `PRINTER_USB`
+(e.g. `PRINTER_USB=vid:2d37:pid:62de`, found via `lsusb`) in a `.env` or the environment, then
+run `labeljetty` and open **http://localhost:8888/**.
+
+> Prefer Docker? The image is [`motey/labeljetty`](https://hub.docker.com/r/motey/labeljetty).
+
+## Heads-up
+
+- **No authentication by default** - fine on a trusted home LAN, but turn on `AUTH_MODE=protected`
+  before exposing it to an untrusted network.
+- **Reference hardware is a Vretti 420B** (Poskey-class TSPL, ~203 dpi). It should work with any
+  USB TSPL printer; feedback/PRs for other models are welcome.
+
+## More information
+
+Full docs, the configuration reference, authentication, the REST API, printer/udev setup, and
+Homebox integration live on **GitHub: https://github.com/motey/LabelJetty**