Skip to content

README.md

Latest commit

 

History

History
65 lines (54 loc) · 2.09 KB

README.md

File metadata and controls

65 lines (54 loc) · 2.09 KB
Raw

modem-info

PyPi Version PyPI Status Python Versions License Last Commit Build Status

Collect and plot detailed information and statistics from your modem.

An example plot of DOCSIS modem statistics

Installation

Install Python, then install pipx and use it to install modem-info:

pipx install modem-info

Usage

Note: Ensure the --path (default: ./data) exists and is writable.

To collect statistics from a supported modem, use the get command with at least one of --csv or --json:

modem-info get [--csv] [--json] <ADDRESS>

To plot statistics that were saved in CSV format, use the plot command:

modem-info plot <FILE>

For all options, run:

modem-info <COMMAND> --help

Supported Modems

Vendor Model Driver Package
Hitron CODA-45 modem_info.drivers.hitron.coda45

Development Environment

Installation

git clone https://github.com/ReK42/modem-info.git
cd modem-info
python -m venv .env
source .env/bin/activate
python -m pip install --upgrade pip pre-commit
pre-commit install
pip install -e .[test]

Manual Testing

mypy src
ruff check src
ruff format --diff src

Manual Building

pip install -e .[build]
python -m build