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.1.tar.gz (322.8 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.1-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for bbrpy-0.3.1.tar.gz
Algorithm Hash digest
SHA256 e01efda3ee678765f4648be006ff2a9fd64e78c7b2499f4b4eee18d207ed0e48
MD5 a807f9b06a7714408675de926830ebb5
BLAKE2b-256 1ed9c748c9aaa3a22dd10a73249c3b19e5d2b184513356f71e7a55fb7264f309

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for bbrpy-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2f1c9f3556182d954d786d862e52831d124582e24f1c5bf669714e58a201d5ae
MD5 300bdb997023d95cb5d6410de3a09631
BLAKE2b-256 debee3018edd1c6f680d8e4eeb4fde154105f670ea3cd716ade16c1ff2231020

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