Metadata-Version: 2.3
Name: python-rockbox
Version: 0.2.1
Summary: Create and manipulate WPS tags from Python
Author: Stormy
Author-email: Stormy <oohstormy@gmail.com>
Requires-Python: >=3.14
Description-Content-Type: text/markdown

# python-rockbox

Create and manipulate WPS tags from Python

### Currently supported:
* All tags from Rockbox 4.0 (via `Tags` class)
* Tags (`Tag` class)
* Rockbox formatted hex color (`Color` class)
* Conditionals (`Match` class)
* If statements (`If` class)

## Examples

This conditional that displays an appropriate battery bitmap:
```py
wps = Match(
    Tags.IS_CHARGING,
    [
        Tag(Tags.DISPLAY_IMAGE, "A"),
        Match(
            Tags.BATTERY_PERCENTAGE,
            [
                Tag(Tags.DISPLAY_IMAGE, "B"),
                Tag(Tags.DISPLAY_IMAGE, "C"),
                Tag(Tags.DISPLAY_IMAGE, "D"),
                Tag(Tags.DISPLAY_IMAGE, "E"),
                Tag(Tags.DISPLAY_IMAGE, "F"),
            ],
        ),
    ],
)
```

Would `__repr__` to:
```c
%?bp<%xd(A)|%?bl<%xd(B)|%xd(C)|%xd(D)|%xd(E)|%xd(F)>>
```

This if statement:
```py
wps = If(Tags.VOLUME, ">=", 0, [
    "Clipping possible",
    "Volume OK"
])
```

Would `__repr__` to:
```c
%?if(%pv, >=, 0)<Clipping possible|Volume OK>
```

## Install

To install locally, make sure you have the following installed:
* A modern version of Python 3 (I target 3.14)
* git
* pip

First, clone the repository:
```sh
git clone https://git.0stormy.xyz/stormy/python-rockbox.git
```

Next, change directories into the folder you just cloned:
```sh
cd python-rockbox
```

Finally, install it locally with:
```sh
pip install -e .
```