[]()
[](https://GitHub.com/twyleg/construction_meta_data_builder/commit/)
[](https://pypi.python.org/pypi/constructions-meta-data-builder/)
[](https://pypi.org/project/constructions-meta-data-builder)
# 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](https://github.com/twyleg/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](https://github.com/twyleg/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/**
Raw data
{
"_id": null,
"home_page": "https://github.com/twyleg/construction_meta_data_builder",
"name": "construction-meta-data-builder",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "FreeCAD Export Constructions Generator",
"author": "Torsten Wylegala",
"author_email": "mail@twyleg.de",
"download_url": "https://files.pythonhosted.org/packages/93/de/e13d40aab4c95e79a19bd157ce2e6d452221417e14837dd12568213b61ad/construction_meta_data_builder-0.0.1.tar.gz",
"platform": null,
"description": "[]()\n[](https://GitHub.com/twyleg/construction_meta_data_builder/commit/)\n[](https://pypi.python.org/pypi/constructions-meta-data-builder/)\n[](https://pypi.org/project/constructions-meta-data-builder)\n\n\n# construction_meta_data_builder\n\nThe construction meta data builder generates README files for FreeCAD workspaces.\nIts main goal is to serve for my personal [constructions](https://github.com/twyleg/constructions) repo. \n\n## Installation\n\n cd construction_workspace/\n python -m venv venv\n venv/bin/activate\n\n pip install construction_meta_data_builder\n\n## Usage\n\n cd construction_workspace/\n construction_meta_data_builder\n\n## System dependencies\n\nThe following packages need to be installed and made available to the user that runs the construction_meta_data_builder.\n\n* freecad\n* xvfb (to run freecad headless)\n\n## Examples\n\nCheck [constructions](https://github.com/twyleg/constructions) repo for a productive example project.\n\n## Caveats\n\n* **Ubuntu/Snap based distribution**: \n * The construction_meta_data_builder requires FreeCAD to generate isometric preview images of constructions.\n * On snap based distributions it is likely that FreeCAD is installed via snap.\n * 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.\n * 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.\n * In tox we're using **.pytest_tmp/**\n",
"bugtrack_url": null,
"license": "GPL 3.0",
"summary": "README file generator for FreeCAD construction workspaces.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/twyleg/construction_meta_data_builder"
},
"split_keywords": [
"freecad",
"export",
"constructions",
"generator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "06956b4efc4843e93e4560624fbfa4d5618ea6b103d16d11e8940f9bff615cd8",
"md5": "7159490a5e38f54d2e9a6edd3b277af3",
"sha256": "e7b38298ac420729d392c2fc393fca42c233ad9e43204ff92bf2139eff2cc094"
},
"downloads": -1,
"filename": "construction_meta_data_builder-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7159490a5e38f54d2e9a6edd3b277af3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 44023,
"upload_time": "2024-09-17T20:17:32",
"upload_time_iso_8601": "2024-09-17T20:17:32.392961Z",
"url": "https://files.pythonhosted.org/packages/06/95/6b4efc4843e93e4560624fbfa4d5618ea6b103d16d11e8940f9bff615cd8/construction_meta_data_builder-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "93dee13d40aab4c95e79a19bd157ce2e6d452221417e14837dd12568213b61ad",
"md5": "7da93f598414fb1b8e8d3c9da143edce",
"sha256": "e9e4f9684cae0cea6555ba842b56174b1558edd7810fd3388e7302274ed056d4"
},
"downloads": -1,
"filename": "construction_meta_data_builder-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "7da93f598414fb1b8e8d3c9da143edce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 63004,
"upload_time": "2024-09-17T20:17:34",
"upload_time_iso_8601": "2024-09-17T20:17:34.041575Z",
"url": "https://files.pythonhosted.org/packages/93/de/e13d40aab4c95e79a19bd157ce2e6d452221417e14837dd12568213b61ad/construction_meta_data_builder-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-17 20:17:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "twyleg",
"github_project": "construction_meta_data_builder",
"github_not_found": true,
"lcname": "construction-meta-data-builder"
}
JSON
