Metadata-Version: 2.4
Name: winspot
Version: 0.2.1
Summary: A CLI utility to export and reset Windows Spotlight images.
Author: Volodymyr Horshenin
License-Expression: MIT
Project-URL: Repository, https://github.com/l1asis/winspot.git
Project-URL: Issues, https://github.com/l1asis/winspot/issues
Keywords: windows,windows-10,windows-11,windows-spotlight,spotlight,spotlight-images,wallpapers,wallpaper-downloader,desktop-customization,background-images,desktop,lockscreen,cli,utility
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Utilities
Classifier: Environment :: Console
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: Microsoft :: Windows :: Windows 11
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: src/winspot/vendor/licenses/get_image_size.LICENSE.txt
Dynamic: license-file

# winspot

winspot is a Python utility and command-line tool to export and reset Windows Spotlight images.

## Installation

> [!WARNING]
> The project was not uploaded to PyPI yet. The installation instructions below assume that it will be available in the future.

Install directly from PyPI using [pip](https://pip.pypa.io/en/stable/) or [pipx](https://pipx.pypa.io/stable/):

```bash
pip install winspot
# or
pipx install winspot
```

Or install the latest version from source:

```bash
git clone https://github.com/l1asis/winspot.git
cd winspot
pip install .
```

## Usage

### CLI

Run the tool to automatically save Spotlight images:

```bash
winspot
```

For more options (like output directory):

```bash
winspot --help
```

### As a Library

```python
import winspot

# Default: Save everything (cached, desktop, lockscreen)
winspot.extract_wallpapers()

# Save only cached wallpapers
winspot.extract_wallpapers(desktop=False, lockscreen=False)

# Save only desktop wallpapers
winspot.extract_wallpapers(cached=False, lockscreen=False)

# Try to save only lockscreen
winspot.extract_wallpapers(cached=False, desktop=False)

# Reset Windows Spotlight settings
winspot.reset_windows_spotlight()
```

## Contributing

Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.

## Acknowledgments

* Thanks to Paulo Scardine for the `get_image_size.py` script used in this project.

## License

Distributed under the MIT License. See [`LICENSE`](https://github.com/l1asis/winspot/blob/main/LICENSE) for more information.
