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
and 2108
, 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 ------------------------------------------------------------------+
| batch-combine Batch combine XBM files for each logger and dump a |
| serialized `XBMLog` instance to CSV. |
| dash Dash UI launchers |
+-----------------------------------------------------------------------------+
Usage
xbmini batch-combine
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
xbmini dash
A series of helper UIs are provided by Dash. Running the CLI commands will start a local server for the user to interact with.
WARNING: These apps are intended for use on a development server only. Do not use them in a production environment.
A list of available UIs can be accessed via the command line:
$ xbmini dash --help
Usage: xbmini dash [OPTIONS] COMMAND [ARGS]...
Dash UI launchers
+- Options -------------------------------------------------------------------+
| --help Show this message and exit. |
+-----------------------------------------------------------------------------+
+- Commands ------------------------------------------------------------------+
| trim Helper UI for trimming serialized XBMLog CSVs. |
+-----------------------------------------------------------------------------+
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for xbmini_py-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45153ca4344080799823ac990bd10f443886680673f5f6bafa984f49c2cad775 |
|
MD5 | 35cf251e962b730740b8554ab40c6d79 |
|
BLAKE2b-256 | 0abf5089d62286685e3efbedc443883882459ee5488f918dbbd2c228a635f87a |