Skip to main content

An advanced Python application and library for generating 2D and 3D models in OpenSCAD

Project description

SuperSCAD

Legal Docs Release Code
PyPI - License Documentation Status Latest Stable Version
Code Coverage unit Tests

The OO Programmers Solid 3D CAD Modeller

SuperSCAD is an advanced application/library for generating 2D and 3D models in OpenSCAD in Python. SuperSCAD is based, among others, on the factory pattern and delivers to you as 2D and 3D modeler the superpowers of Python.

Documentation

The full documentation is available at https://superscad.readthedocs.io.

Getting Started and Installing SuperSCAD

We advise to create a Python virtual environment in a project folder:

cd awsesome-project

python -m venv .venv
. .venv/bin/activate
pip install super-scad

Using your favorite editor, copy-paste the code from the demo in the next section and save the file under openscad-logo.py.

vi openscad-logo.py  

Run python and open the generated openscad-logo.scad in openscad.

python openscad-logo.py
openscad openscad-logo.scad

Congratulations, you just finished your first SuperSCAD project.

Demo

Below is an example of SuperSCAD utilizing the factory pattern.

from super_scad.boolean.Difference import Difference
from super_scad.d3.Cylinder import Cylinder
from super_scad.d3.Sphere import Sphere
from super_scad.other.Modify import Modify
from super_scad.scad.Context import Context
from super_scad.scad.Scad import Scad
from super_scad.scad.ScadWidget import ScadWidget
from super_scad.scad.Unit import Unit
from super_scad.transformation.Rotate3D import Rotate3D


class Logo(ScadWidget):
    """
    SuperSCAD widget for generating OpenSCAD logo.
    """

    def build(self, context: Context):
        """
        Builds a SuperSCAD widget.

        :param context: The build context.
        """
        size: float = 50.0
        hole: float = size / 2.0
        height: float = 1.25 * size

        cylinder = Cylinder(height=height, diameter=hole, center=True, fn4n=True)
        sphere = Sphere(diameter=size, fn4n=True)

        return Difference(children=[sphere,
                                    cylinder,
                                    Modify(highlight=True, child=Rotate3D(angle_x=90.0, child=cylinder)),
                                    Rotate3D(angle_y=90.0, child=cylinder)])


if __name__ == '__main__':
    scad = Scad(context=Context(fn=360))
    logo = Logo()
    scad.run_super_scad(logo, 'logo.scad')

The example generates the logo of OpenSCAD.

OpenSCAD Logo

Links

License

This project is licensed under the terms of the MIT license.

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

super_scad-0.9.6.tar.gz (46.1 kB view details)

Uploaded Source

Built Distribution

super_scad-0.9.6-py3-none-any.whl (91.1 kB view details)

Uploaded Python 3

File details

Details for the file super_scad-0.9.6.tar.gz.

File metadata

  • Download URL: super_scad-0.9.6.tar.gz
  • Upload date:
  • Size: 46.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.11.6-200.fc40.x86_64

File hashes

Hashes for super_scad-0.9.6.tar.gz
Algorithm Hash digest
SHA256 ac63b47a78de7720e30eac04b3a6d35cd3feb042f2e4120b6c859038c7431afd
MD5 0109913a800574d148d089b7790bcc57
BLAKE2b-256 9650df7a8215e77e7721545ea0bf05ac9b33600a9ec1bb06c5c6f353d5a1636c

See more details on using hashes here.

File details

Details for the file super_scad-0.9.6-py3-none-any.whl.

File metadata

  • Download URL: super_scad-0.9.6-py3-none-any.whl
  • Upload date:
  • Size: 91.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.11.6-200.fc40.x86_64

File hashes

Hashes for super_scad-0.9.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3e861a597a5cdc0a13909cef7f53c98d6253cc5e80edd9ea362b658fdfe69fbd
MD5 0a4f0401d67c06a19665a7c889008d27
BLAKE2b-256 57ec286beb2c4eb8585c90f73b763ad3f974cd0cc0eae69347ea90ecae14e76d

See more details on using hashes here.

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