Skip to main content

A Jupyter widget to view cad objects

Project description

cad-viewer-widget

A Jupyter widget to view CAD objects

cad-viewer-widgets has its origin in Jupyter-CadQuery, which now has been split into 3 layers. This repo being the middle layer:

  1. three-cad-viewer This is the complete CAD viewer written in Javascript with threejs being the only dependency.

  2. cad-view-widget (this repository) A thin layer on top of cad-viewer-widget that wraps the CAD viewer into an ipywidget. The API documentation can be found here

  3. Jupyter-CadQuery A CadQuery viewer, collecting and tessellating CadQuery objects, using cad-view-widget to visualize the objects

Click on the "launch binder" icon to start cad-viewer-widget on binder:

Binder: Latest development version

Examples

Installation

To install use pip:

$ pip install cad_viewer_widget

For a development installation (requires Node.js and Yarn version 1),

$ git clone https://github.com/bernhard-42/cad-viewer-widget.git
$ cd cad-viewer-widget
$ pip install -e . 
$ jupyter labextension develop . --overwrite 

When actively developing your extension for JupyterLab, run the command:

$ jupyter labextension develop --overwrite cad_viewer_widget

Then you need to rebuild the JS when you make a code change:

$ cd js
$ yarn run build

You then need to refresh the JupyterLab page when your javascript changes.

Build step

hatch build

Changes

2023-08-14

  • Adapt to ocp-tessellate
  • Support version 1.8.6 of three-cad-viewer
  • Supports jupyterlab>=4, ipywidgets>=8 and notebook>7
  • Dropped support for notebook < 7.0
  • Build process now uses pyproject.toml and hatch

2023-01-03

  • Added pyparsing as dependency
  • Pinned traitlets to ~5.8
  • Upgraded bottle example to occt 7.6.2

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

cad_viewer_widget-2.0.2.tar.gz (473.1 kB view hashes)

Uploaded Source

Built Distribution

cad_viewer_widget-2.0.2-py3-none-any.whl (409.4 kB view hashes)

Uploaded Python 3

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