Skip to content

Repository files navigation

xbmini-py

PyPI - Python VersionPyPIPyPI - Licensepre-commit.ci status

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

ParameterDescriptionTypeDefault
--top-dirPath to top-level log directory to search.1Path|NoneGUI Prompt
--log-patternXBMini log file glob pattern.2str"*.CSV"
--dry-runShow processing pipeline without processing any files.boolFalse
--skip-strsSkip files containing any of the provided substrings.list[str]["processed", "trimmed", "combined"]
  1. Log searching will be executed recursively starting from the top directory
  2. Case sensitivity is deferred to the host OS

About

Python Toolkit for the GCDC HAM

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages

Generated from sco1/py-template