Skip to main content

Cross-platform, Python battery status

Simply pip install battery and use like:

import battery
source = 'battery' if battery.is_discharging() else 'AC power'
print(f'On {source} at {battery.percent()}%')
health = battery.capacity() / battery.design_capacity()
print(f'Battery is at {health*100:4.1f}% health.')

The CLI always returns a JSON value:

$ python -m battery
{"is_discharging": true, "percent": 92, "minutes_to_empty": 215, "minutes_to_full": null, "capacity": 2388, "design_capacity": 4381}
$ python -m battery percent
92

Functions

The following functions are available:

  • is_discharging: True iff battery is discharging.
  • is_charging: True iff battery is charging.
  • percent: Integer percentage charge of battery.
  • minutes_to_empty: Minutes of battery life left. May be empty.
  • minutes_to_full: Minutes until the battery is charged. May be empty (or 0 if full).
  • capacity: The present capacity in mWh. mAh on macOS; on Apple Silicon this may be a percentage.
  • design_capacity: The factory capacity in mWh. mAh on macOS.

The following minimum OS versions are supported:

  • macOS 10.2 and later
  • Linux 2.6.24 and later
  • Windows Vista and later

A NotImplementedError is raised for unsupported OSes.

Pull requests and issues are always welcome for better compatibility!

Other notes

Also check out psutil!

The whole package is public domain.

Metadata

Release files for battery 1.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for battery 1.0.4
File Size Uploaded
battery-1.0.4.tar.gz 9.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for battery 1.0.4
File Interpreter ABI Platform
battery-1.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 18.5 kB

Release files / battery-1.0.4.tar.gz

Download URL battery-1.0.4.tar.gz
Size 9.0 kB
Tags Source
SHA-256 checksum
How to use checksums
258d89699c801248704be45f082b48786f03f7047462de9cbe75841cbec3e10d
BLAKE2b-256 checksum
How to use checksums
946bdd376155cb8c649573cb22c3cca2fb1b48d43b04f902e5d2cf397704721b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.12

Release files / battery-1.0.4-py3-none-any.whl

Download URL battery-1.0.4-py3-none-any.whl
Size 9.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b01c685a77c799520dbf7b02343c197aa6fde8f989e6865e35fc5bebb8309333
BLAKE2b-256 checksum
How to use checksums
f255e7be023a6bacffd295ec88dfb266d90c847adf46053f80c57e619a26e37f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.12

Release history Release notifications | RSS feed

This release

1.0.4 This release

2 release files

1.0.3

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page