https://github.com/yeicor-3d/ocp-action

GitHub Action that builds OCP models (CadQuery/Build123d/...), renders them and sets up a model viewer on Github Pages.
https://github.com/yeicor-3d/ocp-action

3d 3d-printing cad cadquery cq-editor model

Last synced: about 2 months ago
JSON representation

GitHub Action that builds OCP models (CadQuery/Build123d/...), renders them and sets up a model viewer on Github Pages.

• Host: GitHub
• URL: https://github.com/yeicor-3d/ocp-action
• Owner: yeicor-3d
• License: mit
• Created: 2023-10-18T18:05:17.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-03-30T10:41:04.000Z (6 months ago)
• Last Synced: 2024-05-22T04:16:55.928Z (4 months ago)
• Topics: 3d, 3d-printing, cad, cadquery, cq-editor, model
• Language: Python
• Homepage: https://yeicor-3d.github.io/ocp-action/
• Size: 49.8 KB
• Stars: 9
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-cadquery - ocp-action - GitHub Action that builds OCP models (CadQuery/Build123d/...), renders them and sets up a model viewer on Github Pages.  (Miscellaneous)

README

        
# OCP action

> [!WARNING]  

> This project has been superseded by [Yet Another CAD Viewer](https://github.com/yeicor-3d/yet-another-cad-viewer), and will no longer be actively maintained.

GitHub Action that builds [OCP](https://github.com/CadQuery/OCP) models ([CadQuery](https://github.com/CadQuery/cadquery)/[Build123d](https://github.com/gumyr/build123d)/...), renders them and sets up a model viewer on Github Pages.

## Features

- Automatically test your model(s) in your CI/CD pipeline

- Automatically build the latest version of your model(s) for release.

- No boilerplate: use the same code from the [CQ-editor](https://github.com/CadQuery/CQ-editor) and in your CI/CD

  pipeline.

- Build a static website to showcase your latest model(s) automatically.

- Take a screenshot of your model(s) and use it as a preview image.

## Usage

This repository also serves as a demo.

The only requirements are a python script to build the model and a [workflow](.github/workflows/ci.yml) to run the

action.

You can use links similar to the following sections to embed your model in your README.md and point to the interactive

model viewer. The latest models can be downloaded from

the [build artifacts](https://github.com/Yeicor/ocp-action/actions/workflows/ci.yml).

### Demo: [box.py](demos/box.py)

[![Demo](https://yeicor-3d.github.io/ocp-action/models/demos/box/simple_box.png)](https://yeicor-3d.github.io/ocp-action/?model=models/demos/box/simple_box.gltf)

![Demo](https://yeicor-3d.github.io/ocp-action/models/demos/box/simple_box.svg)

### Demo: [cycloidal_gear.py](demos/cycloidal_gear.py)

[![Demo](https://yeicor-3d.github.io/ocp-action/models/demos/cycloidal_gear/cycloidal_gear.png)](https://yeicor-3d.github.io/ocp-action/?model=models/demos/cycloidal_gear/cycloidal_gear.gltf)

![Demo](https://yeicor-3d.github.io/ocp-action/models/demos/cycloidal_gear/cycloidal_gear.svg)

### Demo: [parametric_enclosure.py](demos/parametric_enclosure.py)

[![Demo](https://yeicor-3d.github.io/ocp-action/models/demos/parametric_enclosure/topOfLid.png)](https://yeicor-3d.github.io/ocp-action/?model=models/demos/parametric_enclosure/topOfLid.gltf)

[![Demo](https://yeicor-3d.github.io/ocp-action/models/demos/parametric_enclosure/debug-bottom.png)](https://yeicor-3d.github.io/ocp-action/?model=models/demos/parametric_enclosure/debug-bottom.gltf)

![Demo](https://yeicor-3d.github.io/ocp-action/models/demos/parametric_enclosure/topOfLid.svg)

![Demo](https://yeicor-3d.github.io/ocp-action/models/demos/parametric_enclosure/debug-bottom.svg)

### Demo: [build123d_tea_cup.py](demos/build123d_tea_cup.py)

[![Demo](https://yeicor-3d.github.io/ocp-action/models/demos/build123d_tea_cup/tea_cup.png)](https://yeicor-3d.github.io/ocp-action/?model=models/demos/build123d_tea_cup/tea_cup.gltf)

![Demo](https://yeicor-3d.github.io/ocp-action/models/demos/build123d_tea_cup/tea_cup.svg)