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

We try to install the kernel specification automatically. If the kernel does not appear you can try to execute the following command

python -m iopenscad setup

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.10.tar.gz (39.3 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.10-py3-none-any.whl (43.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyter-openscad-kernel-1.0.10.tar.gz
  • Upload date:
  • Size: 39.3 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.10.tar.gz
Algorithm Hash digest
SHA256 17a5bb113b6c80bcd242aea004f9efbed74c4a6d40c981b6785b4c62dcfd75be
MD5 c844ce00fbf065b2648ae32300abfff8
BLAKE2b-256 37c79b7994c773b4feb32c11171561aae173e7ac795702caa7f460c5a45ecf9d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jupyter_openscad_kernel-1.0.10-py3-none-any.whl
  • Upload date:
  • Size: 43.4 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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 30409eb68cdb9c91891e7d21c80f231f132914bf045a6d81927a829823d15e82
MD5 fe0871c138f82c651be0e151660c5f0d
BLAKE2b-256 9d374fe44232819d6c616dab6712cbb8903f784fd2ff5de17f858a7bd654245b

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