Skip to content
gumyr edited this page Mar 18, 2022 · 1 revision

Welcome to the cq_warehouse wiki!

Documentation for cq_warehouse is located at readthedocs here: https://cq-warehouse.readthedocs.io/en/latest/index.html

The following are notes on how to build and test cq_warehouse:

Environment:

  • conda env list
  • conda remove --name freecad_py3 --all
  • conda create -n cq39 python=3.9
  • conda activate cq39
  • conda install -c cadquery -c conda-forge cadquery=master
  • conda install -c cadquery -c conda-forge cq-editor=master
  • pip install coverage
  • from cq_warehouse/
  • pip install -e .

Build:

  • potentially update setup.cfg to a new version

  • create a version of extensions.py (extensions_doc.py) for readthedocs:

  • cd /scripts/

  • python build_extensions_doc.py

  • create the cadquery patch:

  • python build_cadquery_patch.py

  • follow script instructions to remove old patch (if required) and install new one

Testing:

In /tests/

  • coverage run -m unittest *
  • ensure all tests run successfully (will take several minutes)
  • coverage html
  • In a browser navigate to /tests/htmlcov/index.html
  • check for for > 95%
Clone this wiki locally