{"id":16237705,"url":"https://github.com/pschatzmann/jupyter-openscad-kernel","last_synced_at":"2025-03-19T16:30:22.074Z","repository":{"id":43213708,"uuid":"243225893","full_name":"pschatzmann/jupyter-openscad-kernel","owner":"pschatzmann","description":"Jupyter kernel for OpenSCAD","archived":false,"fork":false,"pushed_at":"2022-03-13T08:34:31.000Z","size":412,"stargazers_count":11,"open_issues_count":6,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-13T11:51:51.884Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pschatzmann.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-26T09:42:36.000Z","updated_at":"2023-09-09T06:56:40.000Z","dependencies_parsed_at":"2022-09-10T00:40:47.739Z","dependency_job_id":null,"html_url":"https://github.com/pschatzmann/jupyter-openscad-kernel","commit_stats":null,"previous_names":["pschatzmann/openscad-kernel"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschatzmann%2Fjupyter-openscad-kernel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschatzmann%2Fjupyter-openscad-kernel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschatzmann%2Fjupyter-openscad-kernel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschatzmann%2Fjupyter-openscad-kernel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pschatzmann","download_url":"https://codeload.github.com/pschatzmann/jupyter-openscad-kernel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244003591,"owners_count":20382212,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T13:36:44.087Z","updated_at":"2025-03-19T16:30:21.738Z","avatar_url":"https://github.com/pschatzmann.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenSCAD Kernel for Jupyter\n\nI was missing a Jupyter Kernel for [OpenSCAD](https://www.openscad.org/). So I took up the challenge and here is the result.  \n\nAny 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.\n\n## Preconditions\n- Jupyter or Jupyterlab should have been installed\n- 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:\n\n```\nopenscad -v\n```\ndiplays the version. E.g. 2019.12.20\n\n## Installation\n\n```\npip install jupyter-openscad-kernel\npython -m iopenscad.install\n```\n\n## Installation from source\n\n```\ngit clone https://github.com/pschatzmann/jupyter-openscad-kernel.git\ncd jupyter-openscad-kernel\npip install .\npython -m iopenscad.install\n\n```\n\n## Optional Steps\nIf you want to be able to display stl files you need to install a mime renderer for Jupyter. E.g\n```\njupyter labextension install jupyterlab-viewer-3d\n```\nIf you want to have syntax highlighting for OpenSCAD:\n```\njupyter labextension install jupyterlab-openscad-syntax-highlighting\n```\nOn linux, if you want to run openscad in a headless environment (e.g. Docker) you need to install xvfb\n```\napt install -y xvfb\n```\n\n\nNow you can launch your kernel my calling\n\n```\njupyter lab\n```\nor \n```\njupyter workspace\n```\n## Versions\n- 1.0     Initial Version\n- 1.0.1   Additional syntax checking; Publish to pypi\n- 1.0.13  Error corrections for parser and installer, support for %use\n- 1.0.14  Cleanup and corrections for spelling mistakes, Upgrade node and setuptools release in Dockerfile \n\n## Further Information\n- A quick [Overview](https://www.pschatzmann.ch/home/2020/02/26/an-openscad-kernel-in-jupyter/)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpschatzmann%2Fjupyter-openscad-kernel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpschatzmann%2Fjupyter-openscad-kernel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpschatzmann%2Fjupyter-openscad-kernel/lists"}