Python Toolkit for the GCDC HAM
Project description
xbmini-py
Python Toolkit for the GCDC HAM
Known Firmware Compatibility
This package is currently tested against firmware versions 1379
, 2108
, and 2570
, compatibility with other firmware versions is not guaranteed.
Installation
Install from PyPi with your favorite pip
invocation:
$ pip install xbmini-py
You can confirm proper installation via the xbmini
CLI:
$ xbmini --help
Usage: xbmini [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
merge Combine multiple log sessions.
trim XBMini log trimming.
CLI Usage
xbmini merge batch
Batch combine XBM files for each logger and dump a serialized XBMLog
instance to a CSV in its respective logger's directory.
Input Parameters
Parameter | Description | Type | Default |
---|---|---|---|
--top-dir |
Path to top-level log directory to search.1 | Path|None |
GUI Prompt |
--log-pattern |
XBMini log file glob pattern.2 | str |
"*.CSV" |
--dry-run |
Show processing pipeline without processing any files. | bool |
False |
--skip-strs |
Skip files containing any of the provided substrings. | list[str] |
["processed", "trimmed", "combined"] |
- Log searching will be executed recursively starting from the top directory
- Case sensitivity is deferred to the host OS
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
xbmini_py-0.4.0.tar.gz
(70.8 kB
view details)
Built Distribution
xbmini_py-0.4.0-py3-none-any.whl
(16.3 kB
view details)
File details
Details for the file xbmini_py-0.4.0.tar.gz
.
File metadata
- Download URL: xbmini_py-0.4.0.tar.gz
- Upload date:
- Size: 70.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b20edb7f8375f3789680ab5659ad90ed187daa54fb643eb6803fe4d3411ea80 |
|
MD5 | f9c5a894ba5ea550067ac86b10c83229 |
|
BLAKE2b-256 | 9a1ca50e6715b4920baf6fb4388eb03067be132153d7c2425250329fe55455c4 |
File details
Details for the file xbmini_py-0.4.0-py3-none-any.whl
.
File metadata
- Download URL: xbmini_py-0.4.0-py3-none-any.whl
- Upload date:
- Size: 16.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ef3895a2663ce95b419b8a973be728205d61a596d3dd895b1f86050937fdb21 |
|
MD5 | 472347504892b0f7ae4cd900368a7c50 |
|
BLAKE2b-256 | bc77d0c1967754a9a0a19a353a473321f917dcbc5a1a9a2a27e98522c528eec5 |