cadquery-web-viewer 2.0.0

Web server and viewer for GLB/CAD preview (forked from Yet Another CAD Viewer)

CadQuery Web Viewer

Preview CadQuery or build123d models in your browser and refresh the view while you edit Python—without manually exporting meshes each time.

The API and packaging are meant to be a mostly drop-in replacement for Yet Another CAD Viewer (YACV). Package renames and choosing how Python talks to the viewer—embedded server, separate server process, or buffer-only (server_type)—are covered in Migrating from yacv-server / yacv-viewer; project history and upstream links are in Special thanks at the end of this file.

Table of contents

• Quick start
• What you get
• Documentation
• Examples in this repo
• Related projects
• Special thanks

Documentation

• Installation — pipx, uv tool, Docker, and other install paths
• Usage — long-lived server, cache, show() options
• HTTP API — Flask /api endpoints (SSE, GLB upload, static UI)
• Migrating from YACV
• Development

Quick start

Requires Python 3.10 through 3.12 (see requires-python in pyproject.toml).

Install with pip

The viewer package depends on build123d. The example below uses CadQuery, which is a separate install:

python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate
pip install cadquery-web-viewer cadquery

While the venv is active, run cadquery-web-viewer or python -m cadquery_web_viewer.

Other install methods (pipx, uv tool, Docker): docs/install.md.

Preview a CadQuery box locally

The library starts a small local server and a browser tab. By default the process waits until you close the viewer tab, so short scripts do not exit before you inspect the model.

import cadquery as cq

from cadquery_web_viewer import show

box = cq.Workplane().box(10, 10, 10)
show(box)

More options (host, port, timeouts, multiple show() calls): docs/usage.md.

Same box with a remote server

In one terminal, keep the viewer running:

cadquery-web-viewer --host localhost --port 32323

In another terminal, with the same Python environment:

import cadquery as cq

from cadquery_web_viewer import show

box = cq.Workplane().box(10, 10, 10)
show(
    box,
    server_type="remote",
    remote_options={"host": "localhost", "port": 32323},
)

What you get

• Browser viewer for 3D models: orbit, zoom, measurements, clipping, transparency, and related viewing tools.
• glTF 2.0 / GLB — a standard mesh format many 3D tools understand. The UI is built around the web model-viewer component, so you get common material and lighting behavior in the browser.
• Live updates while you change geometry in Python (the app keeps a channel open so the page can refresh when you publish again).
• Optional disk cache for uploaded GLBs when you run the long-lived server — see Usage.

Examples in this repo

Folder	Purpose
examples/in-process/	Full build123d sample, show() with optional textures; with CI set, runs export_all("export") after the viewer closes (not run in GitHub Actions).
examples/remote/	Same style of model sent with server_type="remote".

Special thanks

Yet Another CAD Viewer (YACV) by Yeicor and contributors is the orginal project: a web-based CAD and GLB viewer with a Python backend for live tessellation, hot reload, and static export. This repository is a hard fork, with credit to the original authors.

MIT License. Third-party notices: assets/licenses.txt.