| Name | pywifi-controls JSON |
| Version |
0.7
JSON |
| download |
| home_page | |
| Summary | Python module to modify screen brightness on Linux, Windows and macOS |
| upload_time | 2023-08-29 23:40:21 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3 |
| 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. |
| keywords |
pywifi
display-settings
brightness-control
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
**Platform Supported**
**Deployments**
[](https://github.com/thevickypedia/pywifi-controls/actions/workflows/pages/pages-build-deployment)
[](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
[](https://packaging.python.org/tutorials/packaging-projects/)
[https://pypi.org/project/pywifi-controls/](https://pypi.org/project/pywifi-controls/)
## Runbook
[](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
© Vignesh Rao
Licensed under the [MIT License](https://github.com/thevickypedia/pywifi-controls/blob/main/LICENSE)
Raw data
{
"_id": null,
"home_page": "",
"name": "pywifi-controls",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "pywifi,display-settings,brightness-control",
"author": "",
"author_email": "Vignesh Sivanandha Rao <svignesh1793@gmail.com>",
"download_url": "",
"platform": null,
"description": "**Platform Supported**\n\n\n\n**Deployments**\n\n[](https://github.com/thevickypedia/pywifi-controls/actions/workflows/pages/pages-build-deployment)\n[](https://github.com/thevickypedia/pywifi-controls/actions/workflows/python-publish.yml)\n\n# PyWiFi-controls\nPython module to control `WiFi` on Linux, Windows and macOS\n\n### Installation\n```shell\npython -m pip install pywifi-controls\n```\n\n### Usage\n**Enable or disable Wi-Fi**\n```python\nfrom pywifi import ControlPeripheral\n\nControlPeripheral().enable() # Turn on Wi-Fi\nControlPeripheral().disable() # Turn off Wi-Fi\n```\n\n**Connect to a Wi-Fi SSID**\n```python\nfrom pywifi import ControlConnection\n\n# Arguments passed during object instantiation\ncontroller = ControlConnection(wifi_ssid='ssid', wifi_password='password')\ncontroller.wifi_connector()\n\n# Argument values taken from env vars\nControlConnection().wifi_connector()\n```\n\n### Arguments\nEnvironment variables are loaded from a `.env` file.\n- **wifi_ssid** - SSID of the Wi-Fi connection.\n- **wifi_password** - Password for the Wi-Fi connection.\n\n## [Release Notes](https://github.com/thevickypedia/pywifi-controls/blob/main/release_notes.rst)\n**Requirement**\n```shell\npython -m pip install gitverse\n```\n\n**Usage**\n```shell\ngitverse-release reverse -f release_notes.rst -t 'Release Notes'\n```\n\n## Linting\n`PreCommit` will ensure linting, and the doc creation are run on every commit.\n\n**Requirement**\n```shell\npip install sphinx==5.1.1 pre-commit recommonmark\n```\n\n**Usage**\n```shell\npre-commit run --all-files\n```\n\n## Pypi Package\n[](https://packaging.python.org/tutorials/packaging-projects/)\n\n[https://pypi.org/project/pywifi-controls/](https://pypi.org/project/pywifi-controls/)\n\n## Runbook\n[](https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html)\n\n[https://thevickypedia.github.io/pywifi-controls/](https://thevickypedia.github.io/pywifi-controls/)\n\n## License & copyright\n\n© Vignesh Rao\n\nLicensed under the [MIT License](https://github.com/thevickypedia/pywifi-controls/blob/main/LICENSE)\n",
"bugtrack_url": null,
"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. ",
"summary": "Python module to modify screen brightness on Linux, Windows and macOS",
"version": "0.7",
"project_urls": {
"Bug Tracker": "https://github.com/thevickypedia/pywifi-controls/issues",
"Docs": "https://thevickypedia.github.io/pywifi-controls/",
"Homepage": "https://github.com/thevickypedia/pywifi-controls",
"Release Notes": "https://github.com/thevickypedia/pywifi-controls/blob/main/release_notes.rst",
"Source": "https://github.com/thevickypedia/pywifi-controls"
},
"split_keywords": [
"pywifi",
"display-settings",
"brightness-control"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f4bb0cfc3426888073066d92f3e15cc68eb520e63dbafc6b0add36cde811ced0",
"md5": "dff6607ef9a7d264f6094b65f283a30d",
"sha256": "c1a203524842663659fa6e2c6daea9f54dbb3b463a954548ee8e59f552f5fde8"
},
"downloads": -1,
"filename": "pywifi_controls-0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dff6607ef9a7d264f6094b65f283a30d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 9086,
"upload_time": "2023-08-29T23:40:21",
"upload_time_iso_8601": "2023-08-29T23:40:21.243334Z",
"url": "https://files.pythonhosted.org/packages/f4/bb/0cfc3426888073066d92f3e15cc68eb520e63dbafc6b0add36cde811ced0/pywifi_controls-0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-29 23:40:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thevickypedia",
"github_project": "pywifi-controls",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pywifi-controls"
}
