Skip to main content

A Python tool for controlling the brightness of your monitor

Project description

screen_brightness_control

A Python tool for controlling the brightness of your monitor. Supports Windows and most flavours of Linux.

Installation

Pip:

pip install screen-brightness-control

GitHub:

git clone https://github.com/Crozzers/screen_brightness_control
cd screen_brightness_control
pip install .

Linux:

Installing on Linux usually requires some extra work after installing the module. Please see the installing on Linux documentation for more details.

Usage

API

import screen_brightness_control as sbc

# get the brightness
brightness = sbc.get_brightness()
# get the brightness for the primary monitor
primary = sbc.get_brightness(display=0)

# set the brightness to 100%
sbc.set_brightness(100)
# set the brightness to 100% for the primary monitor
sbc.get_brightness(100, display=0)

# show the current brightness for each detected monitor
for monitor in sbc.list_monitors():
    print(monitor, ':', sbc.get_brightness(display=monitor), '%')

Check out the quick start guide for more details on each of these functions.

Full documentation for the project is also available here.

Command Line

python -m screen_brightness_control --help
> usage: screen_brightness_control [-h] [-d DISPLAY] [-s VALUE] [-g] [-f VALUE] [-v]
>
> optional arguments:
>   -h, --help                         show this help message and exit
>   -d DISPLAY, --display DISPLAY      the display to be used
>   -s VALUE, --set VALUE              set the brightness to this value
>   -g, --get                          get the current screen brightness
>   -f VALUE, --fade VALUE             fade the brightness to this value
>   -m METHOD, --method METHOD         specify which method to use
>   -l, --list                         list all monitors
>   -v, --verbose                      some messages will be more detailed
>   -V, --version                      print the current version

Contributing

Contributions are welcome. Issues, ideas and pull requests are all appreciated. For more information see here

See Also

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

screen_brightness_control-0.27.0.tar.gz (47.5 kB view details)

Uploaded Source

Built Distribution

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

screen_brightness_control-0.27.0-py3-none-any.whl (36.4 kB view details)

Uploaded Python 3

File details

Details for the file screen_brightness_control-0.27.0.tar.gz.

File metadata

File hashes

Hashes for screen_brightness_control-0.27.0.tar.gz
Algorithm Hash digest
SHA256 ce76fdff16e754bf7c85aa232a7d736f05ee1c99849eed314ec876accb3e862b
MD5 6c26b5cc67c5bfd6cf58e0851c0f844a
BLAKE2b-256 7a6db49a14c62b6980b7daedfb5905f4768b4b34c6303a962e344587aa1341a8

See more details on using hashes here.

File details

Details for the file screen_brightness_control-0.27.0-py3-none-any.whl.

File metadata

File hashes

Hashes for screen_brightness_control-0.27.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bbf36a05f4d3f9f0e06db6868dd794e8396ce97c61801dd4c17488ca3856e513
MD5 0feb1c97eebddfb67f9e68e02a6d537d
BLAKE2b-256 05865023b5ad536482c1b7611e6bd42f359ac6743729e3c4474a277d364d1060

See more details on using hashes here.

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