Jupyterscad

Latest version: v1.0

Safety actively analyzes 623841 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 1 of 2

1.2

* Next Dev Version: `1.3dev`
* Source Branch: `main`


Release Workflow

The release on Github and PyPi performed from a release branch while the release branch PR is in progress. After the releases, the version in the PR is updated before it is merged. Thus, the version in `main` is not the same as the version of the release.

*NOTE: This section refers to version and branch names given in Release Naming Conventions section above.*

1. Starting from the Source Branch, create a release branch named `release-{Release Version}`
1. Make the following changes for the release:
* Update `CHANGELOG.md`, adhering to [Keep a Changelog](https://keepachangelog.com/)
* Update `pyproject.toml` to Release Version
1. Create a PR for the release branch (named after release branch, description is changelog entry, base is Source Branch), wait for CI to pass
1. Create a new github release:
* Set Tag to Release Version
* **!!!** Set Target to the release branch **!!!**
* Set Title to Tag Release Version
* Copy Description from the new entry in the changelog
* Select "This is a pre-release" if applicable
1. Verify the successful run of the Github Action "Autopublish to TestPyPi" and validate the test release on [test.pypi.org](https://test.pypi.org/project/juypterscad/)
1. Run the Github Action "Publish on PyPi", **!!!** Set Branch to the release branch **!!!** This will also deploy the docs to gh-pages.
1. Verify the successful run of the Github Action "Publish on PyPi" and validate the release on [pypi.org](https://pypi.org/project/juypterscad/)
1. Push a commit to the PR updating `pyproject.toml` to Next Dev Version
1. Merge PR
1. Maintenace release only: Merge release tag into `main`

1.1.1

* Next Dev Version: `1.1.2dev`
* Source Branch: `maint-1.1`


Feature Release Example:

**IF** Current Dev Version == `1.2dev` **THEN**

1.0.0

Marked as mature

0.3.1

Changed

- grid autoscale by default (was: grid scale = 1)

Fixed

- fix bug that did not allow for importing stls.

0.3.0

Changed

- `render` renamed to `view`, `visualize_stl` renamed to `view_stl`.

Added

- Output to stderr if openscad rendering encountered an error.

0.2.0

Added

- API documentation
- Full static typing, expanded file paths to support Path or str types.
- Full external documentation pages
- render and visualize_stl: add grid autoscaling when `grid_unit` is set to `-1`

Fixed

- Grid was not aligned with origin for grid_unit != 1 (11). Thank you jeff-dh!
- README references to jupter_scad should be jupyterscad

Changed

- OpenSCAD executable discovery now looks in PATH (which works for Linux) then
in the macOS-specific install path if not found in PATH
- Rename render_stl out_file to outfile for positional arg to match other fcns

Page 1 of 2

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.