Build a release

Prerequisites

  • Git version control system.

  • Python >=3.9, and python-venv.

  • Poetry for Python dependency management and building source and wheel archives.

  • node.js and npm for JavaScript dependency management.

Build

git clone https://github.com/sethfischer/sphinxcontrib-cadquery.git
cd sphinxcontrib-cadquery
poetry env use python3.11
poetry install
poetry shell
npm clean-install
make npm-build poetry-build

Following the above a sdist and wheel will be in the dist/ directory.

Install

The built release can be install into a project as follows.

Poetry

poetry add path/to/dist/sphinxcontrib_cadquery-0.1.0.tar.gz

Pip

pip install path/to/dist/sphinxcontrib_cadquery-0.1.0.tar.gz