Skip to content

pablofueros/bbrpy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

29 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

BBRPY logo

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

Code Quality Release codecov PyPI Latest Release PyPI Downloads versions


๐Ÿ“‹ 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

or using pipx to install it on an isolated environment:

pipx 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 generate [--output PATH]

Options:

  • --output: Specify the output path for the HTML report (default: "./reports/battery_report.html")

This command:

  1. Generates a battery report using powercfg
  2. Creates an interactive visualization of battery capacity history
  3. Opens the report in your default web browser

๐Ÿ“˜ 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