CadQuery 2.0 Documentation

CadQuery is an intuitive, easy-to-use Python library for building parametric 3D CAD models. It has several goals:

• Build models with scripts that are as close as possible to how you’d describe the object to a human, using a standard, already established programming language
• Create parametric models that can be very easily customized by end users
• Output high quality CAD formats like STEP and AMF in addition to traditional STL
• Provide a non-proprietary, plain text model format that can be edited and executed with only a web browser

See CadQuery in Action

This Getting Started Video will show you what CadQuery can do. Please note that the video has not been updated for CadQuery 2.0 and still shows CadQuery use within FreeCAD.

Quick Links

• CadQuery QuickStart
• CadQuery CheatSheet
• CadQuery API Reference

Table Of Contents

• Introduction
  • What is CadQuery
  • CadQuery is a library, GUIs are separate
  • Why CadQuery instead of OpenSCAD?
  • Where does the name CadQuery come from?
• Installing CadQuery
  • Anaconda or Miniconda (Python 3.x editions), Python 3.x
  • Command Line Installation
  • Test Your Installation
  • Adding a Nicer GUI via CQ-editor
• CadQuery QuickStart
  • Prerequisites: Anaconda/Miniconda + CQ-editor running from an environment
  • What we’ll accomplish
  • Start With A single, simple Plate
  • Add the Holes
  • More Holes
  • Filleting
  • Done!
  • Want to learn more?
• CadQuery Design Principles
  • Principle 1: Intuitive Construction
  • Principle 2: Capture Design Intent
  • Principle 3: Plugins as first class citizens
  • Principle 4: CAD models as source code makes sense
• CadQuery Concepts
  • 3D BREP Topology Concepts
  • CQ, the CadQuery Object
  • Workplanes
  • 2D Construction
  • 3D Construction
  • Selectors
  • Construction Geometry
  • The Stack
  • Chaining
  • The Context Solid
  • Iteration
• CadQuery Scripts and Object Output
• CadQuery Examples
  • Simple Rectangular Plate
  • Plate with Hole
  • An extruded prismatic solid
  • Building Profiles using lines and arcs
  • Moving The Current working point
  • Using Point Lists
  • Polygons
  • Polylines
  • Defining an Edge with a Spline
  • Mirroring Symmetric Geometry
  • Mirroring 3D Objects
  • Creating Workplanes on Faces
  • Locating a Workplane on a vertex
  • Offset Workplanes
  • Rotated Workplanes
  • Using construction Geometry
  • Shelling To Create Thin features
  • Making Lofts
  • Making Counter-bored and counter-sunk holes
  • Rounding Corners with Fillet
  • A Parametric Bearing Pillow Block
  • Splitting an Object
  • The Classic OCC Bottle
  • A Parametric Enclosure
  • Lego Brick
  • Braille Example
  • Panel With Various Connector Holes
• CadQuery API Reference
  • Initialization
  • 2-d Operations
  • 3-d Operations
  • File Management and Export
  • Iteration Methods
  • Stack and Selector Methods
  • Selectors
• String Selectors Reference
• Combining Selectors
  • Filtering Faces
  • Filtering Edges
  • Filtering Vertices
  • User-defined Directions
• CadQuery Class Summary
  • Core Classes
  • Topological Classes
  • Geometry Classes
  • Selector Classes
  • Class Details
• The CadQuery Gateway Interface
  • The Script Side
  • The execution environment side
  • More about script variables
  • Important CQGI Methods
  • Complete CQGI API
• Extending CadQuery
  • Using PythonOCC Script
  • Extending CadQuery: Plugins
  • The Stack
  • Preserving the Chain
  • Helper Methods
  • Coordinate Systems
  • Linking in your plugin
  • CadQueryExample Plugins
  • Plugin Example
• RoadMap: Planned Features
  • Core
  • Selectors
  • Workplanes
  • 2-d operations
  • 3-d operations
  • Algorithms

Indices and tables

• Index
• Module Index
• Search Page