Metadata-Version: 2.1
Name: probat
Version: 1.0.2
Summary: Battery life saver and reminder
Home-page: https://github.com/codeswhite/probat
Author: Max G
Author-email: max3227@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: termcolor

## ProBat
**Battery life saver and reminder**

![Usage Screencap](https://i.imgur.com/Phy7vGM.gif)

*Paraphernalia: [Terminator](https://github.com/gnome-terminator/terminator), [Oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh) with [bullet-train theme](https://github.com/caiogondim/bullet-train.zsh), [zsh-syntax-highlighting](https://github.com/zsh-users/zsh-syntax-highlighting) and [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions)*

## Getting Started:
Current requirements are:
 - python-termcolor: colorizing the shell on unix

### Install:

    # Via PIP:
    $ pip install probat


    # From Arch AUR repo:
    $ ... -S python-probat

### Run:

    $ probat

### Pro tip:

    # Add this line to your .bashrc so you will see the battery status at login:
    ...
    # Run `probat` if it's found in $PATH
    command -v probat &>/dev/null && probat
    ...

## Contributing

This project welcomes with open arms any intent to contribute in any way :)

**Please leave feedback and ideas on the [issues](https://github.com/codeswhite/waller/issues) page**

Easily set up the project locally for development/testing purposes:

    $ git clone https://github.com/codeswhite/probat
    $ cd ./probat
    $ pipenv install

Note that installing the python requirements can be **alternatively** done via basic `pip`:

    $ pip install -r requirements.txt


