Skip to main content

Jupyter kernel for OpenSCAD

Project description

OpenSCAD Kernel for Jupyter

I was missing a Jupyter Kernel for OpenSCAD. So I took up the challenge and here is the result.

Any regular text in a cell is added to the overall OpenSCAD code buffer. This allows you to build up an OpenSCAD model in multiple steps using Jupyter cells and document the design along the way.

Preconditions

  • Jupyter or Jupyterlab should have been installed
  • Please make sure that OpenSCAD has been installed on your system (e.g. with apt install openscad) and that it can be called on the command line:
openscad -v

diplays the version. E.g. 2019.12.20

Installation

pip install jupyter-openscad-kernel

Installation from source

git clone https://github.com/pschatzmann/jupyter-openscad-kernel.git
cd openscad-kernel
pip install .

Optional Steps

If you want to be able to display stl files you need to install a mime renderer for Jupyter. E.g

jupyter labextension install jupyterlab-viewer-3d

If you want to have syntax highlighting for OpenSCAD:

jupyter labextension install jupyterlab-openscad-syntax-highlighting

Now you can launch your kernel my calling

jupyter lab

or

jupyter workspace

Versions

  • 1.0 Initial Version
  • 1.0.1 Additional syntax checking; Publish to pypi

Further Information

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

jupyter-openscad-kernel-1.0.1.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jupyter_openscad_kernel-1.0.1-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file jupyter-openscad-kernel-1.0.1.tar.gz.

File metadata

  • Download URL: jupyter-openscad-kernel-1.0.1.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for jupyter-openscad-kernel-1.0.1.tar.gz
Algorithm Hash digest
SHA256 d24bfa580e2b93dea291ed43fb91634dd6ed92115d42c5381b6d126c516fb0b0
MD5 d535824bdebb8597c6976f9d1f8b2620
BLAKE2b-256 9304b1039aba9979e2b6903c67efc0ab95b71e371680356315926733850db278

See more details on using hashes here.

File details

Details for the file jupyter_openscad_kernel-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: jupyter_openscad_kernel-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 11.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for jupyter_openscad_kernel-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8ff794560bb636b96b027e01ce068b7e4911fbae7581dc5709df1d7c8945872b
MD5 27894f8a53f09328722200d9acda1e9f
BLAKE2b-256 6ed98f3c0fbb10d27ff62c851aaea79c5d48f2ca30d7c6821060c3df47c19bc5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page