screen-brightness-control 0.27.1

A Python tool for controlling the brightness of your monitor

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 for all displays
brightness = sbc.get_brightness()
# get the brightness for the primary display only
primary = sbc.get_brightness(display=0)

# set the brightness to 100% for all displays
sbc.set_brightness(100)
# set the brightness to 100% for the primary display only
sbc.set_brightness(100, display=0)

# fade the brightness down to 70% for all displays
sbc.fade_brightness(70)

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

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

• API Documentation
  • FAQ
  • Quick Start Guide
• GitHub page
• PyPI page