jupyter-cadquery

(★ 401)

An extension to render cadquery objects in JupyterLab via pythreejs

File Explorer

Download Latest Version (.zip)

- FUNDING.yml
- launch.json
- settings.json
- clipping.md
- cqparts.md
- faces-edges-vertices.md
- features.md
- jupyter-cadquery.png
- occ.md
- replay.md
- splash.png
- Dockerfile
- run.sh
- - 1-disk-arm.ipynb
  - 1-disk-arm.png
  - 2-hexapod.ipynb
  - 2-hexapod.png
  - 3-jansen-linkage-l.png
  - 3-jansen-linkage.ipynb
  - 3-jansen-linkage.png
  - 4-bearing.ipynb
  - 5-door.ipynb
  - 6-nested-assemblies.ipynb
- 1-cadquery.ipynb
- 2-cadquery-examples.ipynb
- 3-occ.ipynb
- 4-sketches.ipynb
- 5-build123d.ipynb
- 6-show_object.ipynb
- 7-show.ipynb
- 8-show_all.ipynb
- 9-set_viewer_config.ipynb
- - jupyter_cadquery.json
- __init__.py
- _version.py
- app.py
- comms.py
- config.py
- logo.py
- replay.py
- show.py
- tools.py
- Icon Factory.ipynb
- Juypter CadQuery Logo.ipynb
- 0_intro.png
- debugging.gif
- explode.gif
- hexapod-crawling.gif
- hexapod.png
- jupyter-cadquery.png
- measure.gif
- replay.gif
- sidecar.png
- viewer-locations.png
- compare_edges_output.png
- compare_output.png
- compare_rotate.png
- testlib.py
.dockerignore
.gitignore
apt.txt
CHANGELOG.md
environment.yml.bak
LICENSE
Makefile
MANIFEST.in
pyproject.toml
README.md
RELEASE.md
requirements.txt
runtime.txt
validate_nb.py

# Installation Guide

1. Get the code

git clone https://github.com/bernhard-42/jupyter-cadquery

Downloads the entire project code from GitHub to your computer.

cd jupyter-cadquery

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Python 3 Python is required to use pip.

pip install jupyter-cadquery

Installs the package published on PyPI directly — no need to clone the source.

pip install build123d

Installs the package published on PyPI directly — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker run -it --rm -v $WORKDIR:/home/workdir -p 8888:8888 bwalter42/jupyter_cadquery:4.0.2

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install jupyter-cadquery

Installs the package published on PyPI directly — no need to clone the source.

jupyter lab

Launches Jupyter in your browser so you can open and run the notebook (.ipynb) files.

pip install build123d

Installs the package published on PyPI directly — no need to clone the source.

Config dir: /Users/<username>/.jupyter

Type this command into your terminal and run it.

Config dir: /Users/<username>/.pyenv/versions/3.12.9/envs/jcq4/etc/jupyter

Type this command into your terminal and run it.

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

5. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.