Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Kleinkram: CLI

Install the package

pip install kleinkram

Run the CLI

klein

Usage

Here are some basic examples of how to use the CLI.

Listing Files

To list all files in a mission:

klein list -p project-name -m mission-name

Uploading Files

To upload all *.bag files in the current directory to a mission:

klein upload -p project-name -m mission-name *.bag

If you would like to create a new mission on upload use the --create flag.

Downloading Files

To download all files from a mission and save them out:

klein download -p project-name -m mission-name --dest out

You can additionally specify filenames or ids if you only want to download specific files.

Instead of downloading files from a specified mission you can download arbitrary files by specifying their ids:

klein download --dest out *id1* *id2* *id3*

For more information consult the documentation.

Development

Clone the repo

git clone git@github.com:leggedrobotics/kleinkram.git
cd kleinkram/cli

Setup the environment

virtualenv -ppython3.8 .venv
source .venv/bin/activate
pip install -e . -r requirements.txt

Install pre-commit hooks

pre-commit install

Run the CLI

klein --help

Run Tests

pytest .

or if you want to skip slow tests...

pytest -m "not slow" .

Download files

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

Source Distribution

kleinkram-0.38.1.dev20241125112529.tar.gz (36.5 kB view details)

Uploaded Source

Built Distribution

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

kleinkram-0.38.1.dev20241125112529-py3-none-any.whl (45.6 kB view details)

Uploaded Python 3

File details

Details for the file kleinkram-0.38.1.dev20241125112529.tar.gz.

File metadata

File hashes

Hashes for kleinkram-0.38.1.dev20241125112529.tar.gz
Algorithm Hash digest
SHA256 9c245cf8d8a7cbbbd241db75d45a05bb7ade90572fcef359364c994decf6a269
MD5 e01ebb24b17a6400c5f3707a546db95c
BLAKE2b-256 50d33a95828cca8150b40067a6ade5de1b13e1b53d5987c86a798624ff4e7133

See more details on using hashes here.

File details

Details for the file kleinkram-0.38.1.dev20241125112529-py3-none-any.whl.

File metadata

File hashes

Hashes for kleinkram-0.38.1.dev20241125112529-py3-none-any.whl
Algorithm Hash digest
SHA256 f28aa6cff547c8085b4188bca1465237ba61a0e2b99a6e13aed0f9301e4f71bc
MD5 3697f057a56448c78f57e0f9a21526c9
BLAKE2b-256 bfc1ee8c3ca97a6d7378bf27ed4f104b8896b11874a08866aa556d9c80294708

See more details on using hashes here.

Release history Release notifications | RSS feed

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