https://github.com/jmwright/cadquery-freecad-module

A module-workbench combo that adds a CadQuery editor to FreeCAD
https://github.com/jmwright/cadquery-freecad-module

Last synced: 18 days ago
JSON representation

A module-workbench combo that adds a CadQuery editor to FreeCAD

• Host: GitHub
• URL: https://github.com/jmwright/cadquery-freecad-module
• Owner: jmwright
• License: lgpl-3.0
• Created: 2014-11-22T03:17:08.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-01-16T21:14:34.000Z (10 months ago)
• Last Synced: 2024-07-31T22:50:40.732Z (3 months ago)
• Language: Python
• Size: 45.5 MB
• Stars: 118
• Watchers: 12
• Forks: 36
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: changes.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
The CadQuery Module for FreeCAD

=======================

[![GitHub version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=gh&type=6&v=1.2.0&x2=0)](https://github.com/jmwright/cadquery-freecad-module/releases/tag/v1.2.0)

[![License](https://img.shields.io/badge/license-LGPL-lightgrey.svg)](https://github.com/jmwright/cadquery-freecad-module/blob/master/LICENSE)

## Introduction

**NOTE** This workbench repo is not compatible with [CadQuery 2.x](https://github.com/CadQuery/cadquery). However, there is a fork provided by @jpmlt [here](https://github.com/jpmlt/freecad-cadquery2-workbench) that supports CadQuery 2.x, although you have to install CadQuery separately. If you are looking for a self-contained CadQuery 2.x IDE, please use [CQ-editor](https://github.com/CadQuery/CQ-editor).

This is a FreeCAD module (aka workbench) that adds elements like a CadQuery code editor. All of the required libraries are embedded with the workbench, and so it is probably the fastest way to get up and running with CadQuery on a local computer. For users who just want to try CadQuery without installing anything, the [CadQuery Jupyter Notebook](https://mybinder.org/v2/gh/RustyVermeer/tryCQ/master) might be a better choice.

![User Interface](https://github.com/jmwright/cadquery-freecad-module/blob/master/docs/cqfm_user_interface.png)

The documentation for this module/workbench has been rewritten and restructured, and can be found [here](docs/index.md). Below are the main entry points into the documentation.

### Documentation

- [Introduction](docs/index.md#introduction)

- [Installation](docs/installation.md)

- [Usage](docs/usage.md)

- [Developers](docs/developers.md)