[]()
[](https://GitHub.com/twyleg/construction_utils/commit/)
[](https://pypi.python.org/pypi/constructions-utils/)
[](https://pypi.org/project/constructions-utils)
# construction_utils
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_utils
## Usage
cd construction_workspace/
construction_utils
## System dependencies
The following packages need to be installed and made available to the user that runs the construction_utils.
* 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_utils 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_utils",
"name": "construction-utils",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "FreeCAD Export Constructions Generator Utilities",
"author": "Torsten Wylegala",
"author_email": "mail@twyleg.de",
"download_url": "https://files.pythonhosted.org/packages/ae/e5/9c267227232705afd996c1a193e4af552cbe3931e06aa61e759d0a0db2f1/construction_utils-0.2.1.tar.gz",
"platform": null,
"description": "[]()\n[](https://GitHub.com/twyleg/construction_utils/commit/)\n[](https://pypi.python.org/pypi/constructions-utils/)\n[](https://pypi.org/project/constructions-utils)\n\n\n# construction_utils\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_utils\n\n## Usage\n\n cd construction_workspace/\n construction_utils\n\n## System dependencies\n\nThe following packages need to be installed and made available to the user that runs the construction_utils.\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_utils 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": "Utilities for FreeCAD construction workspaces.",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/twyleg/construction_utils"
},
"split_keywords": [
"freecad",
"export",
"constructions",
"generator",
"utilities"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9a977a0ff394589a5255a05bc6ea2dddca35b4200cf1aa1bb7165ac1aef8ec70",
"md5": "554ad0470dae703f1ecd920c0f471069",
"sha256": "0590b062c9d1fd7afb6bf20313ffda29509d0bdd92c8992bc8cd4f568ee671ae"
},
"downloads": -1,
"filename": "construction_utils-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "554ad0470dae703f1ecd920c0f471069",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 45402,
"upload_time": "2024-11-04T12:45:06",
"upload_time_iso_8601": "2024-11-04T12:45:06.423978Z",
"url": "https://files.pythonhosted.org/packages/9a/97/7a0ff394589a5255a05bc6ea2dddca35b4200cf1aa1bb7165ac1aef8ec70/construction_utils-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aee59c267227232705afd996c1a193e4af552cbe3931e06aa61e759d0a0db2f1",
"md5": "4dd227a5ec44efcbf1d955304d9c0811",
"sha256": "6cad4b6f2a0c0a7eef6b99707df875940e50b2c3c2076d4fff7b7ed17fc8f3de"
},
"downloads": -1,
"filename": "construction_utils-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "4dd227a5ec44efcbf1d955304d9c0811",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 64177,
"upload_time": "2024-11-04T12:45:07",
"upload_time_iso_8601": "2024-11-04T12:45:07.886027Z",
"url": "https://files.pythonhosted.org/packages/ae/e5/9c267227232705afd996c1a193e4af552cbe3931e06aa61e759d0a0db2f1/construction_utils-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 12:45:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "twyleg",
"github_project": "construction_utils",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "construction-utils"
}
JSON
