[{"_1":2,"_176":-5,"_177":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_152":153},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_89":-5,"_90":91,"_141":-5,"_142":11,"_143":21,"_144":11,"_145":-5,"_146":11,"_147":-5,"_148":149,"_150":92,"_151":-7},"canonicalUrl","https://hub.docker.com/r/dcowden/cadquery/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","dcowden","reponame","cadquery","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_58":35,"_32":33,"_59":60,"_61":44,"_62":63,"_64":65,"_66":67,"_68":-5,"_69":65,"_70":71,"_72":11,"_73":33,"_74":75,"_80":21,"_81":82,"_86":33,"_87":88},"categories",[],"content_types",[44],"image","date_registered","2016-04-16T17:42:15.309888Z","description","CadQuery packaged as a docker image","is_private","last_updated","2018-12-05T02:14:13.033944Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56,57],"application/vnd.docker.container.image.v1+json","application/vnd.docker.distribution.manifest.v1+prettyjws","name","pull_count",1544,"repository_type","star_count",2,"status",1,"status_description","active","source","collaborator_count","full_description",".. image:: http://dcowden.github.io/cadquery/_static/cadquery_logo_dark.svg\n\n\nANNOUNCEMENT! CadQuery is Moving to https://github.com/CadQuery/cadquery!\n============================================================\n\nVersion 2.0 development is under way It uses pythonOCC instead of FreeCAD, and has tons of cool features\n\n*BUT DONT WORRY!* Version 1.x (this repository ) will be suported until all features are comfortably implemented in the 2.x stream.\n\nWe're happy to be moving to a more open organization, but we're sad we're starting over with our stars. Please give us one at our new home!\n\n\nWhat is CadQuery?\n========================================\n\n|TRAVIS| |APPVEYOR| |COVERALLS| |VERSION| |LICENSE|\n\n.. |TRAVIS| image:: https://travis-ci.org/dcowden/cadquery.svg?branch=master\n :alt: Travis Build Status\n :target: https://travis-ci.org/dcowden/cadquery?branch=master\n\n.. |APPVEYOR| image:: https://ci.appveyor.com/api/projects/status/c7u4yjl8xxlokrw0/branch/master?svg=true\n :alt: Build status\n :target: https://ci.appveyor.com/project/jmwright/cadquery/branch/master\n\n.. |COVERALLS| image:: https://coveralls.io/repos/github/dcowden/cadquery/badge.svg?branch=master\n :alt: Coverage Status\n :target: https://coveralls.io/github/dcowden/cadquery?branch=master\n\n.. |VERSION| image:: https://d25lcipzij17d.cloudfront.net/badge.svg?id=gh&type=6&v=1.2.0&x2=0\n :alt: GitHub version\n :target: https://github.com/dcowden/cadquery/releases/tag/v1.2.0\n\n.. |LICENSE| image:: https://img.shields.io/badge/license-Apache2-blue.svg\n :alt: License\n :target: https://github.com/dcowden/cadquery/blob/master/LICENSE\n\nCadQuery is an intuitive, easy-to-use python based language for building parametric 3D CAD models. CadQuery is for 3D CAD what jQuery is for javascript. Imagine selecting Faces of a 3d object the same way you select DOM objects with JQuery!\n\nCadQuery has several goals:\n\n* Build 3d models with scripts that are as close as possible to how you'd describe the object to a human.\n* Create parametric models that can be very easily customized by end users\n* Output high quality (loss-less) CAD formats like STEP and AMF in addition to traditional STL\n* Provide a non-proprietary, plain text model format that can be edited and executed with only a web browser\n\nUsing CadQuery, you can write short, simple scripts that produce high quality CAD models. It is easy to make many different objects using a single script that can be customized.\n\n\nFull Documentation and a Welcoming Community\n===============================================\nYou can find the full cadquery documentation at `https://dcowden.github.io/cadquery `_\n\nWe also have a Google Group to make it easy to get help from other CadQuery users. We want you to feel welcome and encourage you to join the group and introduce yourself. We would also love to hear what you are doing with CadQuery. https://groups.google.com/forum/#!forum/cadquery\n\nGetting Started With CadQuery\n========================================\n\nInstallation instructions for all following use cases can be found `here `_.\n\nIt is currently possible to use CadQuery for your own projects in 4 different ways:\n* as a plugin for FreeCAD\n* using the Docker Image to operate CadQuery as a CLI\n* as a plugin running on a Jupyter Notebook server\n* a standalone installation\n\nI just want to try things out!\n--------------------------------------------------\n\nIf you are interested in trying CadQuery without installing anything, your best option is to experiment with CadQuery scripts running on a Jupyter server.\n\n|BINDER|\n\n.. |BINDER| image:: https://mybinder.org/badge.svg\n :alt: Binder\n :target: https://mybinder.org/v2/gh/RustyVermeer/tryCQ/master\n\nThat button will launch a Jupyter Server pre-configured with CadQuery and its dependencies. It contains a folder with many useful examples to showcase CadQuery's features.\n\nI'd like to use CadQuery on my own setup\n--------------------------------------------------\n\nThe easiest way to get started with CadQuery is to Install FreeCAD (version 16+) (`http://www.freecadweb.org/ `_), and then to use our great CadQuery-FreeCAD plugin here: `https://github.com/jmwright/cadquery-freecad-module `_\n\nIt includes the latest version of cadquery already bundled, and has super-easy installation on Mac, Windows, and Unix.\n\nIt has tons of awesome features like integration with FreeCAD so you can see your objects, code-autocompletion, an examples bundle, and script saving/loading. Its definitely the best way to kick the tires!\n\nI have other ideas and want to run things my own way\n-----------------------------------------------------------\n\nAwesome! CadQuery is built with this attitude in mind. If none of the existing usage methods work for you, you are more than welcome to forge your own path. You'll probably find the most success using the Docker image. You can alternatively install CadQuery as a standalone package.\n\n\nGetting Started with the docker image\n=======================================\n\nThe CadQuery docker image (`https://hub.docker.com/r/dcowden/cadquery/ `_) includes cadquery and all of its dependencies. It can be used to run cadquery scripts without any installation required ( other than docker, of course)\n\nExamples:\n\nDisplay the Documentation:\n\n.. code-block:: bash\n\n docker run dcowden/cadquery:latest\n\nBuild a local model using stdin/stdout:\n\n.. code-block:: bash\n\n cat Ex001_Simple_Block.py | docker run -i dcowden/cadquery:latest build --in_spec stdin --format STEP --out_spec stdout\n\n ... STEP output on the console\n\nBuild local models and output to the same directory::\n\n docker run -v $PWD:/home/cq -i dcowden/cadquery:latest build --in_spec Ex001_Simple_Block.py --format STEP\n INFO: Reading from file 'Ex001_Simple_Block.py'\n INFO: Parsed Script 'Ex001_Simple_Block.py'.\n INFO: This script provides parameters length,thickness,height, which can be customized at build time.\n INFO: The script will run with default variable values\n INFO: use --param_file to provide a json file that contains values to override the defaults\n INFO: Output Format is 'STEP'. Use --output-format to change it.\n INFO: Output Path is './cqobject-%(counter)d.%(format)s'. Use --out_spec to change it.\n INFO: Script Generated 1 result Objects\n INFO: Writing STEP Output to './cqobject-1.STEP'\n\n\nProjects Using CadQuery\n=========================\n\nThis resin mold was modeled using cadquery and then created on a CNC machine:\n\n|HY0ZD_CABLEFIX| |HY0ZD_FINISHED|\n\n.. |HY0ZD_CABLEFIX| image:: http://dcowden.github.io/cadquery/_static/hyOzd-cablefix.png\n :alt: Cable-fix resin mold: Rendered\n\n.. |HY0ZD_FINISHED| image:: http://dcowden.github.io/cadquery/_static/hyOzd-finished_thumb.jpg\n :alt: Cable-fix resin mold: Finised\n :target: http://dcowden.github.io/cadquery/_static/hyOzd-finished_thumb.jpg\n\n\nThe cadquery script is surprisingly short, and allows easily customizing any of the variables:\n\n.. code-block:: python\n\n import cadquery as cq\n from Helpers import show\n BS = cq.selectors.BoxSelector\n\n # PARAMETERS\n mount_holes = True\n\n # mold size\n mw = 40\n mh = 13\n ml = 120\n\n # wire and fix size\n wd = 6 # wire diameter\n rt = 7 # resin thickness\n rl = 50 # resin length\n rwpl = 10 # resin to wire pass length\n\n # pocket fillet\n pf = 18\n\n # mount holes\n mhd = 7 # hole diameter\n mht = 3 # hole distance from edge\n\n # filling hole\n fhd = 6\n\n # DRAWING\n\n # draw base\n base = cq.Workplane(\"XY\").box(ml, mw, mh, (True, True, False))\n\n # draw wire\n pocket = cq.Workplane(\"XY\", (0, 0, mh)).moveTo(-ml/2., 0).line(0, wd/2.)\\\n .line((ml-rl)/2.-rwpl, 0).line(rwpl, rt).line(rl, 0)\\\n .line(rwpl, -rt).line((ml-rl)/2.-rwpl, 0)\\\n .line(0, -(wd/2.)).close().revolve(axisEnd=(1, 0))\\\n .edges(BS((-rl/2.-rwpl-.1, -100, -100), (rl/2.+rwpl+.1, 100, 100)))\\\n .fillet(pf)\n\n r = base.cut(pocket)\n\n # mount holes\n if mount_holes:\n px = ml/2.-mht-mhd/2.\n py = mw/2.-mht-mhd/2\n r = r.faces(\"`_)\n\n.. image:: http://dcowden.github.io/cadquery/_static/KiCad_Capacitors_SMD_thumb.jpg\n :target: http://dcowden.github.io/cadquery/_static/KiCad_Capacitors_SMD.jpg\n :alt: Surface mount capacitors rendered in KiCad\n\nThis Prusa i3 extruder support uses cadquery to build the model (`https://github.com/adam-urbanczyk/cadquery-models `_):\n\n.. image:: http://dcowden.github.io/cadquery/_static/extruder_support.png\n :alt: Prusa i3 extruder support - FreeCAD model render\n\nThe mach30 project used cadquery to develop a tool that will create a rocket thruster directly from the appropriate equations (`https://opendesignengine.net/projects/yavin-thruster/wiki `_):\n\n.. image:: http://dcowden.github.io/cadquery/_static/march30_landing_page.png\n :target: https://opendesignengine.net/projects/yavin-thruster/wiki\n :alt: mach30 project landing page\n\nThis example uses Jupyter notebook to produce a really cool web-based scripting environment (`https://github.com/RustyVermeer/avnb/blob/master/readme.md `_):\n\n.. image:: http://dcowden.github.io/cadquery/_static/jupyter_showcase_thumb.png\n :alt: Jupyter notebook showcased as animation\n :target: https://github.com/RustyVermeer/cqnb\n\nWe would love to link to your cadquery based project. Just let us know and we'll add it here.\n\n\nWhere does the name CadQuery come from?\n========================================\n\nCadQuery is inspired by jQuery, a popular framework that\nrevolutionized web development involving javascript.\n\nIf you are familiar with jQuery, you will probably recognize several jQuery features that CadQuery uses:\n\n* A fluent API to create clean, easy to read code\n* Language features that make selection and iteration incredibly easy\n* Ability to use the library along side other python libraries\n* Clear and complete documentation, with plenty of samples.\n\n\nWhy CadQuery instead of OpenSCAD?\n========================================\n\nCadQuery is based on OpenCasCade. CadQuery shares many features with OpenSCAD, another open source, script based, parametric model generator.\n\nThe primary advantage of OpenSCAD is the large number of already existing model libraries that exist already. So why not simply use OpenSCAD?\n\nCadQuery scripts have several key advantages over OpenSCAD:\n\n#. **The scripts use a standard programming language**, Python, and thus can benefit from the associated infrastructure.\n This includes many standard libraries and IDEs\n#. **More powerful CAD kernel** OpenCascade is much more powerful than CGAL. Features supported natively\n by OCC include NURBS, splines, surface sewing, STL repair, STEP import/export, and other complex operations,\n in addition to the standard CSG operations supported by CGAL\n#. **Ability to import/export STEP** We think the ability to begin with a STEP model, created in a CAD package,\n and then add parametric features is key. This is possible in OpenSCAD using STL, but STL is a lossy format\n#. **Less Code and easier scripting** CadQuery scripts require less code to create most objects, because it is possible to locate\n features based on the position of other features, workplanes, vertices, etc.\n#. **Better Performance** CadQuery scripts can build STL, STEP, and AMF faster than OpenSCAD.\n\n\nLicense\n====================\n\nCadQuery is licensed under the terms of the `Apache Public License, version 2.0 `_.\n\nOngoing and Future Work\n=============================\n\nCadQuery 2.0 (And future versions)\n-----------------------------------\n\nCadquery 2.0 is under way. 2.0 is based on pythonOCC directly ( rather than FreeCAD ), and is under heavy development.\nBeginning with version 2.0, CadQuery has moved to a new home at `https://github.com/CadQuery/cadquery` CadQuery/cadquery\n\n\nCadQuery GUI (under development)\n-------------------------------------------\n\nWork is underway on a stand-alone gui here: `https://github.com/jmwright/cadquery-gui `_\n\nCadQuery Parts / Assembly Handling\n-------------------------------------------\n\nWork by Fragmuffin is ongoing with the `cqparts `_ repo.\n\nMoving to Python3 and away from FreeCAD as a dependency\n-------------------------------------------------------------\n\nAdam Urbańczyk has been working hard on his own `CQ fork `_ which uses only PythonOCC instead of FreeCAD.\n\nWork has begun on Cadquery 2.0, which will feature:\n\n#. Feature trees, for more powerful selection\n#. Direct use of OpenCascade Community Edition (OCE), so that it is no longer required to install FreeCAD\n\nThe project page can be found here: `https://github.com/dcowden/cadquery/projects/1 `_\n\nA more detailed description of `the plan for CQ 2.0 `_\n","has_starred","hub_user","immutable_tags_settings",{"_76":11,"_77":78},"enabled","rules",[79],".*","is_automated","permissions",{"_83":21,"_84":11,"_85":11},"read","write","admin","user","storage_size",99202990922,"orgData","recentTags",[92,130],{"_93":44,"_94":95,"_96":97,"_98":99,"_100":101,"_50":119,"_120":95,"_121":33,"_122":56,"_58":123,"_124":125,"_126":110,"_127":119,"_128":67,"_129":21},"content_type","creator",10364,"full_size",659352943,"id",16896264,"images",[102],{"_103":104,"_105":106,"_107":108,"_109":110,"_111":112,"_113":114,"_115":108,"_116":-5,"_117":97,"_64":67,"_118":-5},"architecture","amd64","digest","sha256:6f00405d1a7c881d3888d59b93f3b38d7e3598b22ec5c978c8b6a61889b7ab5c","features","","last_pulled","2026-10-06T15:19:25.561292381Z","last_pushed","2018-12-05T02:14:13Z","os","linux","os_features","os_version","size","variant","2018-12-05T02:14:12.591432Z","last_updater","last_updater_username","media_type","latest","repository",639575,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_93":44,"_94":95,"_96":131,"_98":132,"_100":133,"_50":139,"_120":95,"_121":33,"_122":57,"_58":140,"_124":125,"_126":136,"_127":139,"_128":67,"_129":21},65765117,2683845,[134],{"_103":104,"_105":135,"_107":108,"_109":136,"_111":137,"_113":108,"_115":108,"_116":-5,"_117":138,"_64":67,"_118":-5},"sha256:464de3e1fe9f7c45c4700633ed88cad6c15de7eaa2520ee2cd097a86ca4b7157","2026-10-05T18:15:21.669104384Z","2016-04-16T17:46:56Z",65765149,"2016-04-16T17:46:55.82641Z","docker-branch","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":154,"_161":162,"_148":174,"_175":11},{"_40":155,"_42":156,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":157,"_58":35,"_32":33,"_59":60,"_61":44,"_62":63,"_64":65,"_66":67,"_68":-5,"_69":65,"_70":71,"_72":11,"_73":33,"_74":158,"_80":21,"_81":160,"_86":33,"_87":88},[],[44],[56,57],{"_76":11,"_77":159},[79],{"_83":21,"_84":11,"_85":11},"tags",{"_163":63,"_164":-5,"_165":-5,"_166":167},"count","next","previous","results",[168,171],{"_93":44,"_94":95,"_96":97,"_98":99,"_100":169,"_50":119,"_120":95,"_121":33,"_122":56,"_58":123,"_124":125,"_126":110,"_127":119,"_128":67,"_129":21},[170],{"_103":104,"_105":106,"_107":108,"_109":110,"_111":112,"_113":114,"_115":108,"_116":-5,"_117":97,"_64":67,"_118":-5},{"_93":44,"_94":95,"_96":131,"_98":132,"_100":172,"_50":139,"_120":95,"_121":33,"_122":57,"_58":140,"_124":125,"_126":136,"_127":139,"_128":67,"_129":21},[173],{"_103":104,"_105":135,"_107":108,"_109":136,"_111":137,"_113":108,"_115":108,"_116":-5,"_117":138,"_64":67,"_118":-5},[],"canDeleteTags","actionData","errors"]

dcowden/cadquery

Tags for dcowden/cadquery