Skip to main content

Python wallpaper for Humans.

Project description

wallpaper

Get or set the desktop wallpaper

license-apache2 python3+

Works on macOS 10.12+ and Windows 10+, inspired by wallpaper node

Install

only python3 is supported

pip install py-wallpaper

Usage

from wallpaper import get_wallpaper, set_wallpaper

# get current wallpaper's path
print(get_wallpaper())
# /Users/leetao/Workspace/py/wallpaper/tests/bg.jpg # your wallpaper path

# set your photo
set_wallpaper("your photo's path")

API

get_wallpaper(**options)

Returns the path of the current desktop wallpaper.

param::options->dict

        screen *(macOS only)* -> str

            values: `'all'`, `'main'`

            default: `'main'`

The screen to get the wallpaper from. If you set 'all' then .get_wallpaper will return a list.

set_wallpaper(image_path, **options)

Returns a object.

param::image_path -> str

    The path to the image to set as the desktop wallpaper.


param::options -> dict

    screen *(macOS only)* ->  str

    values: `'all'`, `'main'`, or the index of a screen from `.screens()`

    default: `'all'`


The screen to set the wallpaper on.


param::scale *(macOS only)* -> str

    values: `'auto' | 'fill' | 'fit' | 'stretch' | 'center'`

    default: `'auto'`

Scaling method.

TODO

wallpaper on Linux

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

py-wallpaper-0.1.0.tar.gz (2.9 kB view details)

Uploaded Source

Built Distribution

py_wallpaper-0.1.0-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

Details for the file py-wallpaper-0.1.0.tar.gz.

File metadata

  • Download URL: py-wallpaper-0.1.0.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.1

File hashes

Hashes for py-wallpaper-0.1.0.tar.gz
Algorithm Hash digest
SHA256 db7b2c60f081a7d99ed1ce15ee972b4229811483075eeb56279f733df9e9e8a3
MD5 88431a42a7df069c70457768ee32a94f
BLAKE2b-256 ca3decb9a15a60b5c396a199495866617e1e2cde5f9f0e5f0da62c52e78c866b

See more details on using hashes here.

File details

Details for the file py_wallpaper-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: py_wallpaper-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.1

File hashes

Hashes for py_wallpaper-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9876c74913df1867522fd955e42da52e5be5f70474889305cfacf727cfcbde0e
MD5 3bc58cb94c51d3eaf5c7a821d3279ff1
BLAKE2b-256 2171aeba0bf411f4e15a6df9ffdcc1b6dfc4e385bdd4c00ea982e5b0e908ee7c

See more details on using hashes here.

Supported by

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