Skip to main content

Python Toolkit for the GCDC HAM

Project description

xbmini-py

PyPI - Python Version PyPI PyPI - License pre-commit.ci status Code style: black

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:
  batch-combine  Batch combine XBM files for each logger and dump a...
  dash           Dash UI launchers

CLI 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"]
  1. Log searching will be executed recursively starting from the top directory
  2. 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


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.3.0.tar.gz (16.9 kB view details)

Uploaded Source

Built Distribution

xbmini_py-0.3.0-py3-none-any.whl (17.8 kB view details)

Uploaded Python 3

File details

Details for the file xbmini_py-0.3.0.tar.gz.

File metadata

  • Download URL: xbmini_py-0.3.0.tar.gz
  • Upload date:
  • Size: 16.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.18

File hashes

Hashes for xbmini_py-0.3.0.tar.gz
Algorithm Hash digest
SHA256 2ded55e24a1505cd12c07eae52fec5c2b183243beca92de6a83f3064e7f44393
MD5 41e53184ffd86896a47b73c307ff3d1f
BLAKE2b-256 29ab33632ce419e6275d16421cc3bb356fe66a6dbcb11a6d7202722189363759

See more details on using hashes here.

Provenance

File details

Details for the file xbmini_py-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: xbmini_py-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 17.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.18

File hashes

Hashes for xbmini_py-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 64fdf1f37e50dd54e89073d4e7fe4ccdf0b6cb1702858a1003db6e96e0d94d29
MD5 b9883391a2104b88f0c5e76d70c51e03
BLAKE2b-256 5d4d52a642995631b95551e70d8c326668a1080ddb5bb64883dd34c940f84606

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page