FreeCAD Workbench Python Programming

Introduction

This page is meant as a comprehensive collection of resources for how to create a FreeCAD workbench using Python programming.

Environment Setup

1. Install FreeCAD

See FreeCAD for instructions.

2. Setting up a Modern Code Editor - VS Code

Related Blog Article: FreeCAD External Editor With Code – OSS

The above resources cover how to enable auto-completion and debugging features.

• VS Code Python Extension

• FreeCAD Forum - Using Visual Studio as Python editor

• FreeCAD Wiki - Debugging (VSCode)

• FreeCAD Forum - Please demonstrate using a remote text editor to substitute the Python editor in FreeCAD

• FreeCAD Forum - VSCode / Pylint question

• FreeCAD Forum - FreeCAD python type definitions, code documentation

• FreeCAD Forum - How to set up a scripting environment in Visual Studio Code

• FreeCAD Forum - vscode, pipenv, and and environment variables...

• FreeCAD Forum - A few question about Wiki Script Object examples: "VSCode is good and has python support ... Maybe I should add a section like that to the documentation."

• FreeCAD Forum - VSCode / Pylint on Windows

• FreeCAD Forum - video tutorial Create a Workbench

Where to Learn

TODO: Begin grouping links into related sub-sections.

• FreeCAD Wiki - Python scripting tutorial
• FreeCAD Wiki - FreeCAD Scripting Basics
• FreeCAD Wiki - Scripted objects
• FreeCAD Wiki - Topological data scripting
• FreeCAD Wiki - Placement
• FreeCAD Wiki - FeaturePython objects
• FreeCAD Wiki - App FeaturePython
• FreeCAD Wiki - Creating a FeaturePython Box, Part II
• FreeCAD Wiki - Dialog Creation
• FreeCAD Wiki - PySide

Where to Get Help

• FreeCAD Forums - Python scripting and macros
• OSE Slack Channel