construction-meta-data-builder 0.0.1

README file generator for FreeCAD construction workspaces.

construction_meta_data_builder

The construction meta data builder generates README files for FreeCAD workspaces. Its main goal is to serve for my personal constructions repo.

Installation

cd construction_workspace/
python -m venv venv
venv/bin/activate

pip install construction_meta_data_builder

Usage

cd construction_workspace/
construction_meta_data_builder

System dependencies

The following packages need to be installed and made available to the user that runs the construction_meta_data_builder.

• freecad
• xvfb (to run freecad headless)

Examples

Check constructions repo for a productive example project.

Caveats

• Ubuntu/Snap based distribution:
  • The construction_meta_data_builder requires FreeCAD to generate isometric preview images of constructions.
  • On snap based distributions it is likely that FreeCAD is installed via snap.
  • Snap applications run in a sandbox and therefore have their own private /tmp/ directory and won't be able to access the systems /tmp/ directory.
  • Unittest rely heavily on the tmp dir. Therefor it is necessary to use pytests --basetemp=<PATH> argument to pass a custom temp directory to pytest.
  • In tox we're using .pytest_tmp/