Metadata-Version: 2.1
Name: pywifi-controls
Version: 0.8
Summary: Python module to modify screen brightness on Linux, Windows and macOS
Author-email: Vignesh Sivanandha Rao <svignesh1793@gmail.com>
License: MIT License
        
        Copyright (c) 2023 Vignesh Rao
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/thevickypedia/pywifi-controls
Project-URL: Docs, https://thevickypedia.github.io/pywifi-controls/
Project-URL: Source, https://github.com/thevickypedia/pywifi-controls
Project-URL: Bug Tracker, https://github.com/thevickypedia/pywifi-controls/issues
Project-URL: Release Notes, https://github.com/thevickypedia/pywifi-controls/blob/main/release_notes.rst
Keywords: pywifi,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
License-File: LICENSE
Requires-Dist: python-dotenv>=0.21.0
Requires-Dist: pyobjc-framework-CoreWLAN; platform_system == "Darwin"
Requires-Dist: Jinja2==3.1.2; platform_system == "Windows"
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/pywifi-controls/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/thevickypedia/pywifi-controls/actions/workflows/pages/pages-build-deployment)
[![pypi-publish](https://github.com/thevickypedia/pywifi-controls/actions/workflows/python-publish.yml/badge.svg)](https://github.com/thevickypedia/pywifi-controls/actions/workflows/python-publish.yml)

# PyWiFi-controls
Python module to control `WiFi` on Linux, Windows and macOS

### Installation
```shell
python -m pip install pywifi-controls
```

### Usage
**Enable or disable Wi-Fi**
```python
from pywifi import ControlPeripheral

ControlPeripheral().enable()  # Turn on Wi-Fi
ControlPeripheral().disable()  # Turn off Wi-Fi
```

**Connect to a Wi-Fi SSID**
```python
from pywifi import ControlConnection

# Arguments passed during object instantiation
controller = ControlConnection(wifi_ssid='ssid', wifi_password='password')
controller.wifi_connector()

# Argument values taken from env vars
ControlConnection().wifi_connector()
```

### Arguments
Environment variables are loaded from a `.env` file.
- **wifi_ssid** - SSID of the Wi-Fi connection.
- **wifi_password** - Password for the Wi-Fi connection.

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

**Usage**
```shell
gitverse-release 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/pywifi-controls/](https://pypi.org/project/pywifi-controls/)

## 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/pywifi-controls/](https://thevickypedia.github.io/pywifi-controls/)

## License & copyright

&copy; Vignesh Rao

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