Skip to main content

Tools for importing ROS .msg files into Capella data package and vice versa.

Project description

Capella ROS Tools

image image

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

Showcase

Documentation

Read the full documentation on Github pages.

Examples

Import local ROS .msg files to Capella model layer's root data package:

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:

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:

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:

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.

pip install capella-ros-tools

To set up a development environment, clone the project and install it into a virtual environment.

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 for details.

Licenses

This project is compliant with the REUSE Specification Version 3.0.

Copyright DB InfraGO AG, licensed under Apache 2.0 (see full text in LICENSES/Apache-2.0.txt)

Dot-files are licensed under CC0-1.0 (see full text in LICENSES/CC0-1.0.txt)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

capella_ros_tools-0.1.dev66.tar.gz (224.1 kB view details)

Uploaded Source

Built Distribution

capella_ros_tools-0.1.dev66-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file capella_ros_tools-0.1.dev66.tar.gz.

File metadata

  • Download URL: capella_ros_tools-0.1.dev66.tar.gz
  • Upload date:
  • Size: 224.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for capella_ros_tools-0.1.dev66.tar.gz
Algorithm Hash digest
SHA256 8d14f1e77ec80764d5f83a5bbb25352e6bfcbad8df35727bbca5dbb8604b4b05
MD5 2c348d7d6bef03eca3848c63f3dacdfa
BLAKE2b-256 677236d5d16fc5f55dbed76761cc322debede88cf56db22ed06448268903cf11

See more details on using hashes here.

Provenance

File details

Details for the file capella_ros_tools-0.1.dev66-py3-none-any.whl.

File metadata

File hashes

Hashes for capella_ros_tools-0.1.dev66-py3-none-any.whl
Algorithm Hash digest
SHA256 36d81ea8ebf52eca0f15ae65ccb6de8f3fe59cd15363302d56e7977de3b258eb
MD5 5a1c6253396579f0e36fec837a661128
BLAKE2b-256 fe5c6176659cb2ee1a23cde2de1227058d53e5f2b1768d74f5b6619ce75f502f

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page