Skip to main content

A tool to create and package ROS 2 robot applications

Project description

A tool to generate skeletons of robot applications, mission controllers, tasks and skills.

Relies on ROS 2 and the ROS 2 Intents interface.

Installation

rpk is written in python3.

Installation with pip

pip install rpk

Installation from source with pip

You require the following libraries:

pip install jinja2

You can install rpk as any other python package as follows:

pip install .

If the location where it is installed is not yet on your path, you will get a warning which includes the path location where it has been installed. You need to add this location to your path, e.g., in linux export PATH="$HOME/.local/bin:$PATH" or in [windows use the GUI or command line](https://stackoverflow.com/questions/9546324/adding-a-directory-to-the-path-environment-variable-in-windows)

Installation with ROS debian (only availabe in PAL Robotics docker images/robots)

sudo apt install pal-alum-rpk

The re-source /opt/pal/alum/setup.bash: source /opt/pal/alum/setup.bash

Building your first rpk

Once you have installed rpk, you are ready to create new applications for your robots. To do so, you just have to run:

rpk create

… and follow the instructions!

It will create a ROS2 package ready to be run.

You’re then ready to play with the application controller. Visit the PAL SDK documentation for further information.

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

rpk-5.1.0.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rpk-5.1.0-py3-none-any.whl (1.5 MB view details)

Uploaded Python 3

File details

Details for the file rpk-5.1.0.tar.gz.

File metadata

  • Download URL: rpk-5.1.0.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for rpk-5.1.0.tar.gz
Algorithm Hash digest
SHA256 b8f276136882baa19e33fcd4ec2d4fa16548dba02a095f4ed1adac17163d45e3
MD5 478e9623397677d73cd576dd45d89991
BLAKE2b-256 e8eaeb3c5904b8a1a758b74548590bce9ed083c6702e851ed1256ea98a41c398

See more details on using hashes here.

File details

Details for the file rpk-5.1.0-py3-none-any.whl.

File metadata

  • Download URL: rpk-5.1.0-py3-none-any.whl
  • Upload date:
  • Size: 1.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for rpk-5.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a3680e4094e69ffc61f7852cb1d594ca2f711c1c2df8c4b2a9672ad452778f52
MD5 95de77cad6c3e79dc4766f44e79e0ebc
BLAKE2b-256 e56d5d2255026d4f53b0ebe43dc83f60f12c14a400f78d02efcb67825e0b28d3

See more details on using hashes here.

Supported by

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