Metadata-Version: 2.1
Name: bargets
Version: 0.1.0rc1
Summary: Tiny arsenal of widgets for statusbars
Author: Niklas Larsson
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/nikkelarsson/bargets/issues
Project-URL: Source, https://github.com/nikkelarsson/bargets
Keywords: widgets utilities statusbars
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: ruamel.yaml

# About
Bargets is a small set of tiny but nice little widgets to be used in a statusbar, such
as Polybar, i3bar etc.

Where does the name, "bargets", come from? [Bar] Wid[gets].

# Installation
``` bash
pip install bargets
```

# Usage
To use a widget in your statusbar, simply provide path to the widget in your
statusbar's config. Make sure to check where **pip** installed the widgets, by
typing `which <widget name>` against any of the widgets, so that you know what
path to use.

### Example: polybar
The following is a snippet of how you could use the battery widget with **polybar**:

``` lua
[battery]
type = custom/script
exec = $HOME/.local/bin/bargets-battery
interval = 5
```

# Configuration: bargets.yaml
If you wish, you can configure each widget how you like in **bargets.yaml**.
First, you need to create a file called **bargets.yaml** to ~/.config/bargets.
You can copy example configuration from [here](examples).

# Widgets
| Widget       | Command          |
| -----------: | :--------------- |
| CPU          | bargets-cpu      |
| Battery      | bargets-battery  |

# Requirements
| Requirement  | Note          |
| -----------: | :------------ |
| Python       | 3.8 or higher |
| OS           | MacOS, Linux  |

# Todo
- [ ] Add tests
- [ ] Add command line options


