| Name | screen-brightness-control JSON |
| Version |
0.24.2
JSON |
| download |
| home_page | None |
| Summary | A Python tool for controlling the brightness of your monitor |
| upload_time | 2025-01-19 17:12:49 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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](https://crozzers.github.io/screen_brightness_control/extras/Installing%20On%20Linux.html) documentation for more details.
# Usage
### API
```python
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](https://crozzers.github.io/screen_brightness_control/extras/Quick%20Start%20Guide.html) for more details on each of these functions.
Full documentation for the project is also available [here](https://crozzers.github.io/screen_brightness_control).
### 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](https://github.com/Crozzers/screen_brightness_control/blob/main/CONTRIBUTING.md)
# See Also
* [API Documentation](https://crozzers.github.io/screen_brightness_control)
* [FAQ](https://crozzers.github.io/screen_brightness_control/extras/FAQ.html)
* [Quick Start Guide](https://crozzers.github.io/screen_brightness_control/extras/Quick%20Start%20Guide.html)
* [GitHub page](https://github.com/Crozzers/screen_brightness_control)
* [PyPI page](https://pypi.org/project/screen-brightness-control/)
Raw data
{
"_id": null,
"home_page": null,
"name": "screen-brightness-control",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Crozzers <captaincrozzers@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/56/2d/c0c4b224c5aa5467d392c632e4ad9dd6f0904c165a67aa58ab9e148ba075/screen_brightness_control-0.24.2.tar.gz",
"platform": null,
"description": "# screen_brightness_control\nA Python tool for controlling the brightness of your monitor. Supports Windows and most flavours of Linux.\n\n# Installation\n#### Pip:\n`pip install screen-brightness-control`\n\n#### GitHub:\n```\ngit clone https://github.com/Crozzers/screen_brightness_control\ncd screen_brightness_control\npip install .\n```\n\n#### Linux:\nInstalling on Linux usually requires some extra work after installing the module.\nPlease see the [installing on Linux](https://crozzers.github.io/screen_brightness_control/extras/Installing%20On%20Linux.html) documentation for more details.\n\n\n# Usage\n\n### API\n\n```python\nimport screen_brightness_control as sbc\n\n# get the brightness\nbrightness = sbc.get_brightness()\n# get the brightness for the primary monitor\nprimary = sbc.get_brightness(display=0)\n\n# set the brightness to 100%\nsbc.set_brightness(100)\n# set the brightness to 100% for the primary monitor\nsbc.get_brightness(100, display=0)\n\n# show the current brightness for each detected monitor\nfor monitor in sbc.list_monitors():\n print(monitor, ':', sbc.get_brightness(display=monitor), '%')\n```\n\nCheck out the [quick start guide](https://crozzers.github.io/screen_brightness_control/extras/Quick%20Start%20Guide.html) for more details on each of these functions.\n\nFull documentation for the project is also available [here](https://crozzers.github.io/screen_brightness_control).\n\n### Command Line\n\n```\npython -m screen_brightness_control --help\n> usage: screen_brightness_control [-h] [-d DISPLAY] [-s VALUE] [-g] [-f VALUE] [-v]\n>\n> optional arguments:\n> -h, --help show this help message and exit\n> -d DISPLAY, --display DISPLAY the display to be used\n> -s VALUE, --set VALUE set the brightness to this value\n> -g, --get get the current screen brightness\n> -f VALUE, --fade VALUE fade the brightness to this value\n> -m METHOD, --method METHOD specify which method to use\n> -l, --list list all monitors\n> -v, --verbose some messages will be more detailed\n> -V, --version print the current version\n```\n### Contributing\nContributions are welcome. Issues, ideas and pull requests are all appreciated. For more information [see here](https://github.com/Crozzers/screen_brightness_control/blob/main/CONTRIBUTING.md)\n\n# See Also\n* [API Documentation](https://crozzers.github.io/screen_brightness_control)\n * [FAQ](https://crozzers.github.io/screen_brightness_control/extras/FAQ.html)\n * [Quick Start Guide](https://crozzers.github.io/screen_brightness_control/extras/Quick%20Start%20Guide.html)\n* [GitHub page](https://github.com/Crozzers/screen_brightness_control)\n* [PyPI page](https://pypi.org/project/screen-brightness-control/)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python tool for controlling the brightness of your monitor",
"version": "0.24.2",
"project_urls": {
"Documentation": "https://crozzers.github.io/screen_brightness_control",
"Issues": "https://github.com/Crozzers/screen_brightness_control/issues",
"Source": "https://github.com/Crozzers/screen_brightness_control"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c6bc829adc48e0ae392abb59a6d8f25e90ca6c150d5221b53dd4737f929ddced",
"md5": "0778bb7d9681fed9efed73aa4db843e0",
"sha256": "189add826705783eba71f2e9b4ca4dbdee5e327519aebd1854834ea5c75ae27f"
},
"downloads": -1,
"filename": "screen_brightness_control-0.24.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0778bb7d9681fed9efed73aa4db843e0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 36237,
"upload_time": "2025-01-19T17:12:47",
"upload_time_iso_8601": "2025-01-19T17:12:47.775409Z",
"url": "https://files.pythonhosted.org/packages/c6/bc/829adc48e0ae392abb59a6d8f25e90ca6c150d5221b53dd4737f929ddced/screen_brightness_control-0.24.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "562dc0c4b224c5aa5467d392c632e4ad9dd6f0904c165a67aa58ab9e148ba075",
"md5": "8a2acb7eebe56e198c6d99a79a587260",
"sha256": "96931b0d80ad3bd4449d35ce20d15d54f72c730bbfae43773464425d30a747a4"
},
"downloads": -1,
"filename": "screen_brightness_control-0.24.2.tar.gz",
"has_sig": false,
"md5_digest": "8a2acb7eebe56e198c6d99a79a587260",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 46712,
"upload_time": "2025-01-19T17:12:49",
"upload_time_iso_8601": "2025-01-19T17:12:49.540445Z",
"url": "https://files.pythonhosted.org/packages/56/2d/c0c4b224c5aa5467d392c632e4ad9dd6f0904c165a67aa58ab9e148ba075/screen_brightness_control-0.24.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-19 17:12:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Crozzers",
"github_project": "screen_brightness_control",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "screen-brightness-control"
}
