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 .
You can also look in scripts for some scripts that might be useful for testing.
1 maintainer
Release files for kleinkram 0.37.0.dev20241118070559
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.37.0.dev20241118070559.tar.gz | 33.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| kleinkram-0.37.0.dev20241118070559-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 75.4 kB
Release files / kleinkram-0.37.0.dev20241118070559.tar.gz
| Download URL | kleinkram-0.37.0.dev20241118070559.tar.gz |
|---|---|
| Size | 33.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1d679cdb81bcfca6b739558ab589a839dc69bf3c774b6d86883850932875ef4e
|
|
BLAKE2b-256 checksum How to use checksums |
d9da907fce5140a4ca03a551ba7631a127eb36167687db5f63715fbccd840d4c
|
| 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.37.0.dev20241118070559-py3-none-any.whl
| Download URL | kleinkram-0.37.0.dev20241118070559-py3-none-any.whl |
|---|---|
| Size | 41.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b2d6d2c1fc795f9c971c286d51ff61a6b3d92c35086432284695329f303b3b2d
|
|
BLAKE2b-256 checksum How to use checksums |
569bf59b1c1186b97b2d8d2a9f556dff9a797934592bc54bd01b6b29294c1429
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
