Skip to main content

rpk

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.

Metadata

Release files for rpk 5.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rpk 5.7.0
File Size Uploaded Provenance Actions
rpk-5.7.0.tar.gz 1.4 MB Without provenance Details for rpk-5.7.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for rpk 5.7.0
File Interpreter ABI Platform Actions
rpk-5.7.0-py3-none-any.whl Python 3 none any Details for rpk-5.7.0-py3-none-any.whl

Total release size: 3.0 MB

Release files / rpk-5.7.0.tar.gz

Download URL rpk-5.7.0.tar.gz
Size 1.4 MB
Tags Source
SHA-256 checksum
How to use checksums
af97fd680c5cf70dc96082d752bb8b3c28fed8f42e331423f8a3a0dc255d7ff1
BLAKE2b-256 checksum
How to use checksums
2b41a1f5f8cbab3c8480d0748747c3d69dca7ac877d88b5006a7637e538602bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release files / rpk-5.7.0-py3-none-any.whl

Download URL rpk-5.7.0-py3-none-any.whl
Size 1.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
1d577feb432029f9aa874934366c606777151ffb70824e18e7f46f30ea0d5fb2
BLAKE2b-256 checksum
How to use checksums
8ee10c89f574f1228efb80213ce45153a06443c05bb4a0bb68b45cadd1f8043c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Security for rpk 5.7.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page