Skip to main content

Better Battery Report for Windows

Project description

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

[!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]

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

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

bbrpy-0.3.4.tar.gz (323.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bbrpy-0.3.4-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file bbrpy-0.3.4.tar.gz.

File metadata

  • Download URL: bbrpy-0.3.4.tar.gz
  • Upload date:
  • Size: 323.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.4

File hashes

Hashes for bbrpy-0.3.4.tar.gz
Algorithm Hash digest
SHA256 4eece7eb7f6947b0eaf9c4b388c607f3eea23ede60968b4a820d2ed210403b18
MD5 62a386aaeda035eb4efc2c4bf9c3e577
BLAKE2b-256 af9c746a9925042b8d23372520c65779e043184dc9dac44e149b9eb631c6bfdd

See more details on using hashes here.

File details

Details for the file bbrpy-0.3.4-py3-none-any.whl.

File metadata

  • Download URL: bbrpy-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.4

File hashes

Hashes for bbrpy-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7e9e322f2d26e0c16df7daf27ceeef1569f3abbd7ab3bbd06ba78bf79aa527ff
MD5 e3f324e1769c41d0736f017f281f50b9
BLAKE2b-256 b80b0579f8778b474d30f2cf79339805ec6ac7ca029b43f77530bbcf8148f67a

See more details on using hashes here.

Supported by

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