Metadata-Version: 2.4
Name: batconcalc
Version: 2023.10
Summary: Laptop Battery Consumption Benchmark tool
Author: frvfrvr
License: MIT License
        
        Copyright (c) 2023 Francis
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: homepage, https://github.com/frvfrvr/batconcalc
Project-URL: repository, https://github.com/frvfrvr/batconcalc.git
Keywords: battery,benchmark,laptop,consumption,power,linux,macbook,windows
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: psutil>=5.9.0
Requires-Dist: pynput>=1.7.6
Dynamic: license-file

# BatConCalc

## battery-consume-calc

Laptop Battery Consumption Benchmark tool

![Battery-consume-calc](https://i.imgur.com/o1xgqq6.png)

You can use this tool to calculate the battery consumption of your laptop. This tool supports csv file logging.

## Installation

- Windows

- Linux

- macOS (Apple Silicon, Big Sur 11.0-)

Install via pip, requires Python 3.11+:
```bash
pip install batconcalc
```



## Roadmap

- [x] AFK (Away from Keyboard) detection  
- [x] Battery cycle count monitoring (macOS, Macbook)
- [x] Battery percentage logging
- [x] export to CSV support
- [ ] battery percentage visual graph on main window
  - [ ] hoverable data points (unlike the default Battery settings)
- [ ] terminal / no GUI support using curses
  - [ ] minimizable without tmux

## Usage

When logging is enabled, the tool will log the following format every time battery percentage changes:\
     `[HH:MM:SS] - [BATTERY_PERCENTAGE] | [BATTERY_STATUS] [if AFK] [BATTERY CYCLE (Macbooks only)]`\

You can add ``--help`` or ``-h`` to see the help menu.

```bash
~) batconcalc --help                                                                               ✔ │ playground Py │ at 11:14:43 
usage: batconcalc [-h] [--afk AFK] [--log LOG] [--version] [--foreground]

Laptop Battery Consumption Benchmark tool

options:
  -h, --help    show this help message and exit
  --afk AFK     AFK time in seconds
  --log LOG     Log file path (filetype: .csv)
  --version     show program's version number and exit
  --foreground  Run in foreground (do not detach from terminal)
```
