| Name | exsource-tools JSON |
| Version |
0.0.8
JSON |
| download |
| home_page | None |
| Summary | Python tools for using Exsource files. |
| upload_time | 2024-11-25 13:43:11 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
documentation
hardware
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ExSource-Tools
An experimental Python library for validating and using the [ExSource Specification](https://gitlab.com/gitbuilding/exsourcespec) which is in the early stage of development.
## Commands
### Make
This packages adds the following command:
exsource-make
This will attempt to process `exsource-def.yml` to create inputs. The first instance of this proof of principle implementation supports OpenSCAD, FreeCAD, and CadQuery files. Each of these must be installed separately if they are to be used.
***FreeCAD***
By default FreeCAD exporter will expect there to be a PartDesign Body called `Body`, it can export this to STEP and/or STL. The body to export can be changed by specifying the label of the object with `object-selected` as a parameter. For example:
```yaml
frame:
name: Main frame
description: >
This frame holds the shelf brackets and shelves.
output-files:
- output/frame.step
- output/frame.stl
source-files:
- assets/frame.FCStd
parameters:
object-selected: "Frame"
application: freecad
```
***CadQuery***
The CardQuery export is performed via [cq-cli](https://github.com/CadQuery/cq-cli)
### Check
You can also use the command:
exsource-check
This will specify what would happen if `exsource-make` was run.
Raw data
{
"_id": null,
"home_page": null,
"name": "exsource-tools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "Documentation, Hardware",
"author": null,
"author_email": "Julian Stirling <julian@julianstirling.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/92/2f/5f2bdda71cf6e833126dc45e09ef50688726831443ac516508097d3acec3/exsource_tools-0.0.8.tar.gz",
"platform": null,
"description": "# ExSource-Tools\n\nAn experimental Python library for validating and using the [ExSource Specification](https://gitlab.com/gitbuilding/exsourcespec) which is in the early stage of development.\n\n## Commands\n\n### Make\n\nThis packages adds the following command:\n\n exsource-make\n\nThis will attempt to process `exsource-def.yml` to create inputs. The first instance of this proof of principle implementation supports OpenSCAD, FreeCAD, and CadQuery files. Each of these must be installed separately if they are to be used.\n\n***FreeCAD*** \nBy default FreeCAD exporter will expect there to be a PartDesign Body called `Body`, it can export this to STEP and/or STL. The body to export can be changed by specifying the label of the object with `object-selected` as a parameter. For example:\n```yaml\nframe:\n name: Main frame\n description: >\n This frame holds the shelf brackets and shelves.\n output-files:\n - output/frame.step\n - output/frame.stl\n source-files:\n - assets/frame.FCStd\n parameters:\n object-selected: \"Frame\"\n application: freecad\n```\n\n***CadQuery*** \nThe CardQuery export is performed via [cq-cli](https://github.com/CadQuery/cq-cli)\n\n### Check\n\nYou can also use the command:\n\n exsource-check\n\nThis will specify what would happen if `exsource-make` was run.\n",
"bugtrack_url": null,
"license": null,
"summary": "Python tools for using Exsource files.",
"version": "0.0.8",
"project_urls": null,
"split_keywords": [
"documentation",
" hardware"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "13410e02fb88f6c0fc9af6f032498b201a9efbcbec5d918eb8239163ac0a70bb",
"md5": "b56a3614e1dc52fd8054787b7686462c",
"sha256": "fe773e2e6a5984e80932ffdc2a6b4441c7099418daac9ed855d5d75bce234734"
},
"downloads": -1,
"filename": "exsource_tools-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b56a3614e1dc52fd8054787b7686462c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 29739,
"upload_time": "2024-11-25T13:43:09",
"upload_time_iso_8601": "2024-11-25T13:43:09.574081Z",
"url": "https://files.pythonhosted.org/packages/13/41/0e02fb88f6c0fc9af6f032498b201a9efbcbec5d918eb8239163ac0a70bb/exsource_tools-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "922f5f2bdda71cf6e833126dc45e09ef50688726831443ac516508097d3acec3",
"md5": "4d155f23f714a322f416637744f11dae",
"sha256": "8aa95e684a5625eabc90f489b063e9af9b34372b507c2c140511d1c902197977"
},
"downloads": -1,
"filename": "exsource_tools-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "4d155f23f714a322f416637744f11dae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 25922,
"upload_time": "2024-11-25T13:43:11",
"upload_time_iso_8601": "2024-11-25T13:43:11.288504Z",
"url": "https://files.pythonhosted.org/packages/92/2f/5f2bdda71cf6e833126dc45e09ef50688726831443ac516508097d3acec3/exsource_tools-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-25 13:43:11",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "exsource-tools"
}
