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
to run unit tests:
pytest -m "not slow"
to run all tests (including e2e and integration tests):
pytest
For the latter you need to have an instance of the backend running locally.
See instructions in the root of the repository for this.
On top of that these tests require particular files to be present in the cli/data/testing directory.
To see the exact files that are required, see cli/testing/backend_fixtures.py.
You also need to make sure to be logged in with the cli with klein login.
1 maintainer
Release files for kleinkram 0.41.0.dev20250303100017
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| kleinkram-0.41.0.dev20250303100017.tar.gz | 37.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| kleinkram-0.41.0.dev20250303100017-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 88.9 kB
Release files / kleinkram-0.41.0.dev20250303100017.tar.gz
| Download URL | kleinkram-0.41.0.dev20250303100017.tar.gz |
|---|---|
| Size | 37.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dd5c2aead6193e0ce0bf0ad0a01b6adef82dd121f3bb6a539dc1323654d375ba
|
|
BLAKE2b-256 checksum How to use checksums |
1b9714cde5b4e3669e4bc040ddb7e2ad12deef241cfebb2b0912266b199dc83d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / kleinkram-0.41.0.dev20250303100017-py3-none-any.whl
| Download URL | kleinkram-0.41.0.dev20250303100017-py3-none-any.whl |
|---|---|
| Size | 51.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
644ad0647a54d3f5847c75af1d18fdebd06a1b4f9b96fa74c5770d1e12f8a2fe
|
|
BLAKE2b-256 checksum How to use checksums |
a9631e44eb8ba038cc1c60a464013020e152635830249189cd7b5ac4875993d0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
