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.3.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.3-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bbrpy-0.3.3.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.3.tar.gz
Algorithm Hash digest
SHA256 192500e94ba18e4115b05896920c9fc689a62494ea1affba7a535cd2abb85a7c
MD5 a912f7d07995b67399ae15c83d3b8f89
BLAKE2b-256 e6887c315a1555214402553f1a7c70cf2c047e36036be286d39a6c8c28cb9cae

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bbrpy-0.3.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b04be9e9309955deb082b62f58e2a1a3c50cb3da3d6d1807ac465a0d98527d1e
MD5 a215598868f2687f4bb427649f7d18af
BLAKE2b-256 20858e3f30e9f4761e121cd0759fd65c2ea91a57ab89a8fc857f7044d175e071

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