bbrpy 0.3.5

Better Battery Report for Windows

---

✨ Better Battery Report: A Python CLI tool that generates enhanced battery reports for Windows systems ✨

---

📋 Features

• Display basic battery information
• Generate battery health reports with interactive visualizations
• Export reports as HTML files with Plotly graphs
• Track battery capacity changes over time

📦 Installation

Since this is a CLI application, it's recommended to run it using uvx:

uvx bbrpy

[!IMPORTANT] This will only install the essential dependencies for running the tool, making it lightweight and portable. For extended use, it may be necessary to install extra dependency groups as well.

It can also be installed into a persistent environment and added to the PATH:

uv tool install bbrpy

Alternatively, you can install it globally using pip:

pip install bbrpy

💻 Usage

The tool provides two main commands:

Display Battery Information

bbrpy info

This command shows basic battery information including:

• Report scan time
• Capacity Status (current / design)

Generate Battery Report

bbrpy report [--output PATH] [--format FORMAT]

Options:

• --output, -o: Specify the output path for the report (default: "./reports/battery_report")
• --format, -f: Report format: 'custom' (interactive html), 'standard' (Windows html), or 'raw' (xml data) (default: "custom")

This command:

1. Generates a battery report using powercfg
2. Creates a report in the specified format:
   • custom: Interactive visualization of battery capacity history with Plotly
   • standard: Default Windows HTML battery report
   • raw: XML data used for parsing
3. Opens HTML reports in your default web browser automatically

📘 Requirements

• Windows operating system
• Python 3.12 or higher
• Administrative privileges (for powercfg command)

⚙️ Technical Details

• powercfg Windows command-line tool for battery data
• pydantic_xml for the default report serialization
• plotly for interactive visualizations
• pandas for data processing
• typer for CLI interface

©️ License

MIT License