Metadata-Version: 2.1
Name: pybrightness
Version: 0.0.0a0
Summary: Python module to modify screen brightness on Linux, Windows and macOS
Author-email: Vignesh Sivanandha Rao <svignesh1793@gmail.com>
Project-URL: Homepage, https://github.com/thevickypedia/pybrightness
Project-URL: Docs, https://thevickypedia.github.io/pybrightness/
Project-URL: Source, https://github.com/thevickypedia/pybrightness
Project-URL: Bug Tracker, https://github.com/thevickypedia/pybrightness/issues
Project-URL: Release Notes, https://github.com/thevickypedia/pybrightness/blob/main/release_notes.rst
Keywords: pybrightness,display-settings,brightness-control
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Terminals :: Terminal Emulators/X Terminals
Requires-Python: >=3
Description-Content-Type: text/markdown
Requires-Dist: python-dotenv (>=0.21.0)
Provides-Extra: dev
Requires-Dist: pre-commit ; extra == 'dev'

**Platform Supported**

![Generic badge](https://img.shields.io/badge/Platform-Linux|MacOS|Windows-1f425f.svg)

**Deployments**

[![pages-build-deployment](https://github.com/thevickypedia/pybrightness/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/thevickypedia/pybrightness/actions/workflows/pages/pages-build-deployment)
[![pypi-publish](https://github.com/thevickypedia/pybrightness/actions/workflows/python-publish.yml/badge.svg)](https://github.com/thevickypedia/pybrightness/actions/workflows/python-publish.yml)

# PyBrightness
Python module to modify screen brightness on Linux, Windows and macOS

### Installation
```shell
python -m pip install pybrightness
```

### Usage
```python
import pybrightness

pybrightness.increase()  # Increase to 100%
pybrightness.decrease()  # Decrease to 100%
pybrightness.custom(percent=72)  # Set to a custom level
```

## Coding Standards
Docstring format: [`Google`](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) <br>
Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br>
Clean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and 
[`isort`](https://pycqa.github.io/isort/)

## [Release Notes](https://github.com/thevickypedia/pybrightness/blob/main/release_notes.rst)
**Requirement**
```shell
python -m pip install changelog-generator
```

**Usage**
```shell
changelog reverse -f release_notes.rst -t 'Release Notes'
```

## Linting
`PreCommit` will ensure linting, and the doc creation are run on every commit.

**Requirement**
```shell
pip install sphinx==5.1.1 pre-commit recommonmark
```

**Usage**
```shell
pre-commit run --all-files
```

## Pypi Package
[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)](https://packaging.python.org/tutorials/packaging-projects/)

[https://pypi.org/project/pybrightness/](https://pypi.org/project/pybrightness/)

## Runbook
[![made-with-sphinx-doc](https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg)](https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html)

[https://thevickypedia.github.io/pybrightness/](https://thevickypedia.github.io/pybrightness/)

## License & copyright

&copy; Vignesh Rao

Licensed under the [MIT License](https://github.com/thevickypedia/pybrightness/blob/main/LICENSE)
