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.dev20241212075157.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.dev20241212075157-py3-none-any.whl (45.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for kleinkram-0.38.1.dev20241212075157.tar.gz
Algorithm Hash digest
SHA256 bc53a62964097315f01e28776b72af1112e063e1917e3303770ca162ce00cd89
MD5 fb7306643f0320eff98138b3bd37bca2
BLAKE2b-256 ffa727bf2da44bc874b573b24554384eab6e0be749b2326760551a31a5bea8d3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kleinkram-0.38.1.dev20241212075157-py3-none-any.whl
Algorithm Hash digest
SHA256 77c45275e535d67323990b7182814e81a9ced12750e89b16dab31843b341a801
MD5 3e2874d275e58fba1e580fcd8fa0d04b
BLAKE2b-256 9ef5b89509239c73c8b8e771bb6b705f8af60a3ebe00ec95c1c625d59ab91c85

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