https://github.com/roipoussiere/cadquery-vscode

Build parametric 2D/3D CAD models in VSCode with the CadQuery library.
https://github.com/roipoussiere/cadquery-vscode

3d cad cadquery modeling parametric python vscode-extension

Last synced: 1 day ago
JSON representation

Build parametric 2D/3D CAD models in VSCode with the CadQuery library.

• Host: GitHub
• URL: https://github.com/roipoussiere/cadquery-vscode
• Owner: roipoussiere
• License: mit
• Created: 2022-03-30T19:09:10.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-05T21:04:27.000Z (about 2 years ago)
• Last Synced: 2024-08-01T22:37:49.121Z (3 months ago)
• Topics: 3d, cad, cadquery, modeling, parametric, python, vscode-extension
• Language: JavaScript
• Homepage: https://open-vsx.org/extension/roipoussiere/cadquery
• Size: 422 KB
• Stars: 17
• Watchers: 4
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-cadquery - VSCode CadQuery Extension - Build parametric 2D/3D CAD models in VSCode with the CadQuery library. (Editors and IDEs)

README

        
# VSCode CadQuery extension

---

**Important note:**

This extension is no longer compatible with the new version of CadQuery Server. Until this is resolved, please use the [LivePreview extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.live-server) instead:

1. install LivePreview;

2. `ctrl+shift+P` -> Simple Browser: Show

3. update the url according to your running CadQuery server instance (ie. `127.0.0.1:5000`).

---

VSCode extension that integrates [CadQuery Server](https://github.com/roipoussiere/cadquery-server) in VSCode.

CadQuery Server is a web server used to render 3d models from CadQuery code loaded dynamically.

![](images/screenshot.png)

## Installation

### Install the IDE

The extension works both on [VSCodium](https://vscodium.com/) or [VSCode](https://code.visualstudio.com/).

### Install the extension

In VSCode, search for *cadquery* in Extensions tab in the sidebar.

The extension is available in:

- [the Open VSX Registry](https://open-vsx.org/extension/roipoussiere/cadquery);

- [the VisualStudio marketplace](https://marketplace.visualstudio.com/items?itemName=roipoussiere.cadquery).

Alternatively, you can manually install the extension in VSCode by downloading the vsix file from one on both registries.

### Install CadQuery Server

Read [installation instructions](https://github.com/roipoussiere/cadquery-server#installation).

## Usage

### 1. Run the CadQuery server

You can configure the server url in the VSCode extension settings (which is `http://127.0.0.1:5000` by default).

    source venv/bin/activate # required if you used a virtual environment

    cq-server

Read [usage instructions](https://github.com/roipoussiere/cadquery-server#usage) for advanced use.

### 2. Activate the extension

Hit `f7` to enable the viewer. Alternatively you can use the VSCode command palette (`Ctrl+Shift+P`) and search for `Open CadQuery viewer`.

The preview should be updated each time your CadQuery Python script is saved.

### 3. Tips and tricks

You should use a language server to activate code completion, such as Pylance. Note that in order to make it work on VSCodium, you must set the `nameLong` value to `Visual Studio Code` in your `product.json` (located at `/usr/share/codium/resources/app/product.json` on Linux).

You can make the UI lighter by enabling VSCode Zen mode by hitting `Ctrl+K` then `Z`.

## About

- contact:

    - ping user `@roipoussiere` on channel `other-gui` in the CadQuery Discord;

    - [Mastodon](https://mastodon.tetaneutral.net/@roipoussiere);

- license: [MIT](./LICENSE);

- source: [Framagit](https://framagit.org/roipoussiere/cadquery-vscode) (Gitlab instance) / [Github](https://github.com/roipoussiere/cadquery-vscode) (mirror);

- issue tracker: [Framagit](https://framagit.org/roipoussiere/cadquery-vscode/-/issues) / [Github](https://github.com/roipoussiere/cadquery-vscode/issues)