Metadata-Version: 2.4
Name: PyTaskbar
Version: 0.1.1
Summary: The ultimate taskbar progress python package!
Author: N3RDIUM, Tim Lodemann
License: MIT License
        
        Copyright (c) 2021 somePythonProgrammer
        
        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/N3RDIUM/PyTaskbar
Project-URL: Repository, https://github.com/N3RDIUM/PyTaskbar.git
Project-URL: Issues, https://github.com/N3RDIUM/PyTaskbar/issues
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: comtypes
Dynamic: license-file

# PyTaskbar
The ultimate taskbar progress python package!

## About
This is a wrapper API around the TaskbarLib.tlb (Windows 7+) that makes it easy
to show progress in the taskbar icon, a great plus when it comes to UX for your
desktop/TUI application. Simple API, works with any GUI framework!

## Installation
This package is available on PyPI! For most cases, installation is as simple as:
```
pip install PyTaskbar
```

If you want to install latest git instead:
```
pip install git+https://github.com/N3RDIUM/PyTaskbar.git
```

## Usage
Here's a minimal usage example:

```python
import time
from PyTaskbar import TaskbarProgress, ProgressType

# This will target the terminal window.
progress = TaskbarProgress()

# If you're using a GUI framework, pass the target window handle like so:
# progress = TaskbarProgress(window_handle)

# No progress
progress.set_progress_type(ProgressType.NOPROGRESS)
time.sleep(3)

# Indeterminate progress state
progress.set_progress_type(ProgressType.INDETERMINATE)
time.sleep(3)

# Normal (green) progress
progress.set_progress_type(ProgressType.NORMAL)
for i in range(100):
    progress.set_progress(i)
    time.sleep(0.05)

# Paused (yellow) progress
progress.set_progress_type(ProgressType.PAUSED)
progress.set_progress(42)
time.sleep(2)

# Error (red) progress
progress.set_progress_type(ProgressType.ERROR)
progress.set_progress(42)
time.sleep(2)

# Flash the taskbar icon signalling that the task completed
progress.flash_done()
time.sleep(5)
```

## Thanks and citations
- [@timminator](https://github.com/timminator) for helping fix the minimize bug

