FreeCAD Workbench Python Programming: Difference between revisions

From Open Source Ecology
Jump to navigation Jump to search
Line 42: Line 42:
'''TODO:''' Begin grouping links into related sub-sections.
'''TODO:''' Begin grouping links into related sub-sections.


==Getting Started==
==Introduction to Scripting in FreeCAD==
* [https://wiki.freecadweb.org/index.php?title=Python_scripting_tutorial FreeCAD Wiki - Python scripting tutorial]
* [https://wiki.freecadweb.org/index.php?title=FreeCAD_Scripting_Basics FreeCAD Wiki - FreeCAD Scripting Basics]
 
==Getting Started with Workbench Programming==
* [https://wiki.freecadweb.org/Workbench_creation FreeCAD Wiki - Workbench Creation]
* [https://wiki.freecadweb.org/Workbench_creation FreeCAD Wiki - Workbench Creation]
* [https://wiki.freecadweb.org/Module_Creation#Setting_up_a_new_module_manually FreeCAD Wiki - Module Creation: Setting up a new module manually]
* [https://wiki.freecadweb.org/Module_Creation#Setting_up_a_new_module_manually FreeCAD Wiki - Module Creation: Setting up a new module manually]
Line 54: Line 58:
* [https://wiki.freecadweb.org/Scripted_objects FreeCAD Wiki - Scripted objects]`
* [https://wiki.freecadweb.org/Scripted_objects FreeCAD Wiki - Scripted objects]`


==Other==
==Reference==
'''TODO:''' Come up with better name than "Other"
* [https://wiki.freecadweb.org/index.php?title=Python_scripting_tutorial FreeCAD Wiki - Python scripting tutorial]
* [https://wiki.freecadweb.org/index.php?title=FreeCAD_Scripting_Basics FreeCAD Wiki - FreeCAD Scripting Basics]
* [https://wiki.freecadweb.org/Topological_data_scripting FreeCAD Wiki - Topological data scripting]
* [https://wiki.freecadweb.org/Topological_data_scripting FreeCAD Wiki - Topological data scripting]
* [https://wiki.freecadweb.org/Placement FreeCAD Wiki - Placement]
* [https://wiki.freecadweb.org/Placement FreeCAD Wiki - Placement]

Revision as of 01:36, 3 May 2020

Introduction

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

Target Audience

This page is meant for people who are comfortable with Python Programming already.

Please refer to other resources for Programming or Python, and do not include them here.

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.

Where to Learn

TODO: Begin grouping links into related sub-sections.

Introduction to Scripting in FreeCAD

Getting Started with Workbench Programming

FeaturePython, Scripted, or Custom Objects

Reference

Where to Get Help