Name | capella-ros-tools JSON |
Version |
0.1.dev68
JSON |
| download |
home_page | None |
Summary | Tools for importing ROS .msg files into Capella data package and vice versa. |
upload_time | 2024-11-18 10:06:15 |
maintainer | None |
docs_url | None |
author | DB InfraGO AG |
requires_python | <3.13,>=3.10 |
license | Apache-2.0 |
keywords |
|
VCS |
 |
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
<!--
~ Copyright DB InfraGO AG and contributors
~ SPDX-License-Identifier: Apache-2.0
-->
# Capella ROS Tools


Tools for importing ROS .msg files into Capella `DataPackage`, `DataType` and
`Class` objects, or exporting those objects to .msg files.

# Documentation
Read the [full documentation on Github pages](https://dsd-dbs.github.io/capella-ros-tools).
# Examples
Import local ROS .msg files to Capella model layer's root data package:
```sh
python -m capella_ros_tools \
import \
-i tests/data/data_model/example_msgs \
-m tests/data/empty_project_60 \
-l la \
--no-deps
```
Import remote ROS .msg files to Capella model layer's root data package:
```sh
python -m capella_ros_tools \
import \
-i git+https://github.com/DSD-DBS/dsd-ros-msg-definitions-oss \
-m tests/data/empty_project_60 \
-l la
```
Export local Capella model layer's root data package as ROS .msg files:
```sh
python -m capella_ros_tools \
export \
-m tests/data/melody_model_60 \
-l la \
-o tests/data/melody_msgs
```
Export remote Capella model layer's root data package as ROS .msg files:
```sh
python -m capella_ros_tools \
export \
-m git+https://github.com/DSD-DBS/coffee-machine \
-l sa \
-o tests/data/coffee_msgs
```
# Installation
You can install the latest released version directly from PyPI.
```sh
pip install capella-ros-tools
```
To set up a development environment, clone the project and install it into a
virtual environment.
```sh
git clone https://github.com/DSD-DBS/capella-ros-tools
cd capella-ros-tools
python -m venv .venv
source .venv/bin/activate.sh # for Linux / Mac
.venv\Scripts\activate # for Windows
pip install -U pip pre-commit
pip install -e '.[docs,test]'
pre-commit install
```
# Contributing
We'd love to see your bug reports and improvement suggestions! Please take a
look at our [guidelines for contributors](CONTRIBUTING.md) for details.
# Licenses
This project is compliant with the
[REUSE Specification Version 3.0](https://git.fsfe.org/reuse/docs/src/commit/d173a27231a36e1a2a3af07421f5e557ae0fec46/spec.md).
Copyright DB InfraGO AG, licensed under Apache 2.0 (see full text in
[LICENSES/Apache-2.0.txt](LICENSES/Apache-2.0.txt))
Dot-files are licensed under CC0-1.0 (see full text in
[LICENSES/CC0-1.0.txt](LICENSES/CC0-1.0.txt))
Raw data
{
"_id": null,
"home_page": null,
"name": "capella-ros-tools",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "DB InfraGO AG",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/51/b8/7b72b2ec7e662383c9ce2fc6093a590490c36b63cb657d93d018853208e9/capella_ros_tools-0.1.dev68.tar.gz",
"platform": "any",
"description": "<!--\n ~ Copyright DB InfraGO AG and contributors\n ~ SPDX-License-Identifier: Apache-2.0\n -->\n\n# Capella ROS Tools\n\n\n\n\nTools for importing ROS .msg files into Capella `DataPackage`, `DataType` and\n`Class` objects, or exporting those objects to .msg files.\n\n\n\n# Documentation\n\nRead the [full documentation on Github pages](https://dsd-dbs.github.io/capella-ros-tools).\n\n# Examples\n\nImport local ROS .msg files to Capella model layer's root data package:\n\n```sh\npython -m capella_ros_tools \\\nimport \\\n-i tests/data/data_model/example_msgs \\\n-m tests/data/empty_project_60 \\\n-l la \\\n--no-deps\n```\n\nImport remote ROS .msg files to Capella model layer's root data package:\n\n```sh\npython -m capella_ros_tools \\\nimport \\\n-i git+https://github.com/DSD-DBS/dsd-ros-msg-definitions-oss \\\n-m tests/data/empty_project_60 \\\n-l la\n```\n\nExport local Capella model layer's root data package as ROS .msg files:\n\n```sh\npython -m capella_ros_tools \\\nexport \\\n-m tests/data/melody_model_60 \\\n-l la \\\n-o tests/data/melody_msgs\n```\n\nExport remote Capella model layer's root data package as ROS .msg files:\n\n```sh\npython -m capella_ros_tools \\\nexport \\\n-m git+https://github.com/DSD-DBS/coffee-machine \\\n-l sa \\\n-o tests/data/coffee_msgs\n```\n\n# Installation\n\nYou can install the latest released version directly from PyPI.\n\n```sh\npip install capella-ros-tools\n```\n\nTo set up a development environment, clone the project and install it into a\nvirtual environment.\n\n```sh\ngit clone https://github.com/DSD-DBS/capella-ros-tools\ncd capella-ros-tools\npython -m venv .venv\n\nsource .venv/bin/activate.sh # for Linux / Mac\n.venv\\Scripts\\activate # for Windows\n\npip install -U pip pre-commit\npip install -e '.[docs,test]'\npre-commit install\n```\n\n# Contributing\n\nWe'd love to see your bug reports and improvement suggestions! Please take a\nlook at our [guidelines for contributors](CONTRIBUTING.md) for details.\n\n# Licenses\n\nThis project is compliant with the\n[REUSE Specification Version 3.0](https://git.fsfe.org/reuse/docs/src/commit/d173a27231a36e1a2a3af07421f5e557ae0fec46/spec.md).\n\nCopyright DB InfraGO AG, licensed under Apache 2.0 (see full text in\n[LICENSES/Apache-2.0.txt](LICENSES/Apache-2.0.txt))\n\nDot-files are licensed under CC0-1.0 (see full text in\n[LICENSES/CC0-1.0.txt](LICENSES/CC0-1.0.txt))\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Tools for importing ROS .msg files into Capella data package and vice versa.",
"version": "0.1.dev68",
"project_urls": {
"Documentation": "https://dsd-dbs.github.io/capella-ros-tools",
"Homepage": "https://github.com/DSD-DBS/capella-ros-tools"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "826cc962eb7bacb551134f840f00357d08a48bb0fee847f46e6c3a9c6954bfcf",
"md5": "0042e9cb18ba6ced8989345ed59e0db7",
"sha256": "1803882c2307c83504c64f13112399b221f51238932a59bfa7e5d3c65a7bacf1"
},
"downloads": -1,
"filename": "capella_ros_tools-0.1.dev68-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0042e9cb18ba6ced8989345ed59e0db7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 11645,
"upload_time": "2024-11-18T10:06:13",
"upload_time_iso_8601": "2024-11-18T10:06:13.764904Z",
"url": "https://files.pythonhosted.org/packages/82/6c/c962eb7bacb551134f840f00357d08a48bb0fee847f46e6c3a9c6954bfcf/capella_ros_tools-0.1.dev68-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "51b87b72b2ec7e662383c9ce2fc6093a590490c36b63cb657d93d018853208e9",
"md5": "64e7cdfb4d30a009f40e6490923a9f2b",
"sha256": "43610b2a13dbb553b6c8fb1d4d852d7451f5dfe2eba13c1be10102b3b9afc05e"
},
"downloads": -1,
"filename": "capella_ros_tools-0.1.dev68.tar.gz",
"has_sig": false,
"md5_digest": "64e7cdfb4d30a009f40e6490923a9f2b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 224132,
"upload_time": "2024-11-18T10:06:15",
"upload_time_iso_8601": "2024-11-18T10:06:15.529832Z",
"url": "https://files.pythonhosted.org/packages/51/b8/7b72b2ec7e662383c9ce2fc6093a590490c36b63cb657d93d018853208e9/capella_ros_tools-0.1.dev68.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 10:06:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DSD-DBS",
"github_project": "capella-ros-tools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "capella-ros-tools"
}