Skip to main content

A CLI utility to extract, download, and reset Windows Spotlight and Bing daily images.

Project description

winspot

winspot is a Python utility and command-line tool to export, reset, and download Windows Spotlight images. Additionally, it can download Bing's daily images.

Installation

Install directly from PyPI using pip or pipx:

pip install winspot
# or
pipx install winspot

Or install the latest version from source:

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

If you want to download Bing/Spotlight images, make sure to install the optional dependencies:

pip install winspot[dl]
# or from source
pip install .[dl]

Usage

CLI

winspot uses subcommands to organize different operations:

Extract Windows Spotlight

# Save all images (cached, desktop, lockscreen)
winspot extract

# Save only cached images
winspot extract --cached

# Save only desktop image
winspot extract --desktop

# Save only lock screen image
winspot extract --lockscreen

# Save only landscape images with duplicate prevention
winspot extract --orientation landscape --prevent-duplicates

Download Bing Daily Images

# Download today's Bing image in 4K
winspot bing

# Download the last 7 days of images
winspot bing --count 7

# Download in 1080p with specific locale
winspot bing --resolution 1920x1080 --locale de-DE

Reset Windows Spotlight

# Reset with confirmation prompt
winspot --reset

# Force reset without confirmation
winspot --reset --force

For complete help:

winspot --help
winspot extract --help
winspot bing --help

As a Library

import winspot

# Save with default settings (all sources)
winspot.extract_images()

# Save only cached images
winspot.extract_images(desktop=False, lockscreen=False)

# Save only landscape images with duplicate prevention
winspot.extract_images(
    orientation="landscape",
    prevent_duplicates=True
)

# Save with conflict resolution
winspot.extract_images(
    on_conflict="skip",  # or "overwrite", "rename"
)

# Download Bing daily images
winspot.download_bing_daily_images(
    count=7,
    resolution="3840x2160",
    locale="en-US",
    prevent_duplicates=True
)

# 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 for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

winspot-0.3.1.tar.gz (20.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

winspot-0.3.1-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file winspot-0.3.1.tar.gz.

File metadata

  • Download URL: winspot-0.3.1.tar.gz
  • Upload date:
  • Size: 20.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for winspot-0.3.1.tar.gz
Algorithm Hash digest
SHA256 9d986c25aa0e75f509e3bcae7be9c802333d816a707baa37db9cd7931d64fab4
MD5 21e485956b3a91b1a81771dab62ca1e7
BLAKE2b-256 9e8837deef39dc497fe0aa4df4a1c00860728dfad3e2b123f3a78b42311c9109

See more details on using hashes here.

Provenance

The following attestation bundles were made for winspot-0.3.1.tar.gz:

Publisher: publish-to-pypi.yml on l1asis/winspot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file winspot-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: winspot-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 21.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for winspot-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c21aa0a2489b37be84711a29425e9cf077adb7120a572256773158f903c6a9e9
MD5 7aa333a58c59a4f0d49aa85b75c36626
BLAKE2b-256 67594aa0db55f330ec36d57cf8193ebe23399a624126344a978c41bcfb090ec1

See more details on using hashes here.

Provenance

The following attestation bundles were made for winspot-0.3.1-py3-none-any.whl:

Publisher: publish-to-pypi.yml on l1asis/winspot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page