Metadata-Version: 2.4
Name: getwinbg
Version: 0.1.0
Summary: Retrieve Windows background image paths.
Author: Virati Akiranandhan Reddy
License-Expression: MIT
Project-URL: Homepage, https://github.com/viratiakiranandhanreddy/getwinbg
Project-URL: Repository, https://github.com/viratiakiranandhanreddy/getwinbg
Project-URL: Issues, https://github.com/viratiakiranandhanreddy/getwinbg/issues
Keywords: windows,wallpaper,background,desktop,spotlight,bing,Virati Akiranandhan Reddy,viratiakiranandhanreddy
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Desktop Environment
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Typed
Requires-Python: >=3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer>=0.26.7
Dynamic: license-file

# getwinbg

Retrieve Windows background image paths from Python or the command line.

`getwinbg` is a lightweight Windows utility for accessing the current desktop background path.

## Features

* Retrieve the current Windows desktop background path
* Simple Python API
* Command-line interface
* Fully typed package (`py.typed`)

## Installation

### PyPI

```bash
pip install getwinbg
```

### From Source

```bash
git clone https://github.com/ViratiAkiraNandhanReddy/getwinbg.git
cd getwinbg

pip install .
```

## Usage

### CLI

```bash
getwinbg background
```

Example output:

```text
C:\Users\User\Pictures\wallpaper.jpg
```

### Python API

```python
from getwinbg import get_background

path = get_background()
print(path)
```

Example output:

```text
C:\Users\User\Pictures\wallpaper.jpg
```
