# wirelesswizard
## Description
WirelessWizard allows you to use your wireless interface using python.
## Installation
You can install WirelessWizard using `pip3`:
```bash
$ pip3 install wirelesswizard
```
## Basic Usage
### 1. Listing your wireless interfaces
```python
import wirelesswizard
# get a list of the currently available wireless interface in your system
interfaces = wirelesswizard.get_wireless_interfaces()
# selecting an interface
interface_0 = interfaces[0]
# showing information of your wireless interface
interface_0.show_info()
# you can use the attributes of the wireless interface too
print(interface_0.name)
```
### 2. Scanning networks
```python
import wirelesswizard
# selecting an interface
interfaces = wirelesswizard.get_wireless_interfaces()
interface = interfaces[0]
# scanning networks
interface.scan_networks()
# Getting scan results
scan_result = interface.get_last_scan()
# showing scan result
print(scan_result)
# you can also get the scan result in different formats.
# ["raw","table","html","json"]
scan_result = interface.get_last_scan(format="json")
# the history of network scans
print(interface.scan_history)
# select the last scan history (list of NetworkInfo objects)
interface.scan_history[0]
```
### 3. Setting monitor mode
```python
import wirelesswizard
# selecting an interface
interfaces = wirelesswizard.get_wireless_interfaces()
interface = interfaces[0]
# changing interface to monitor mode
interface.change_mode("monitor")
```
### 4. Changing state
```python
import wirelesswizard
# selecting an interface
interfaces = wirelesswizard.get_wireless_interfaces()
interface = interfaces[0]
# executing ip link set <iface> down
interface.change_state("down")
# executing ip link set <iface> up
interface.change_state("up")
```
### 5. Changing
```python
import wirelesswizard
# selecting an interface
interfaces = wirelesswizard.get_wireless_interfaces()
interface = interfaces[0]
# changing to channel 11
interface.change_channel(11)
```
## License
This proyect is under GPL v3 license.
Raw data
{
"_id": null,
"home_page": "https://github.com/mind2hex/wirelesswizard",
"name": "wirelesswizard",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "wireless, interface, WiFi, monitor, Linux, iw, iwconfig, ifconfig",
"author": "mind2hex",
"author_email": "neodeus8@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/28/40/923b8ce4dbddc3556da4638fb1504be495f05cc39782489707fc310b37cd/wirelesswizard-0.1.1a0.tar.gz",
"platform": null,
"description": "# wirelesswizard\n\n## Description\nWirelessWizard allows you to use your wireless interface using python.\n\n## Installation\nYou can install WirelessWizard using `pip3`:\n```bash\n$ pip3 install wirelesswizard\n```\n\n## Basic Usage\n### 1. Listing your wireless interfaces\n```python\nimport wirelesswizard\n\n# get a list of the currently available wireless interface in your system\ninterfaces = wirelesswizard.get_wireless_interfaces()\n\n# selecting an interface\ninterface_0 = interfaces[0]\n\n# showing information of your wireless interface\ninterface_0.show_info()\n\n# you can use the attributes of the wireless interface too\nprint(interface_0.name)\n```\n### 2. Scanning networks\n```python\nimport wirelesswizard\n\n# selecting an interface\ninterfaces = wirelesswizard.get_wireless_interfaces()\ninterface = interfaces[0]\n\n# scanning networks\ninterface.scan_networks() \n\n# Getting scan results\nscan_result = interface.get_last_scan()\n\n# showing scan result\nprint(scan_result)\n\n# you can also get the scan result in different formats. \n# [\"raw\",\"table\",\"html\",\"json\"]\nscan_result = interface.get_last_scan(format=\"json\")\n\n# the history of network scans\nprint(interface.scan_history)\n\n# select the last scan history (list of NetworkInfo objects)\ninterface.scan_history[0]\n```\n### 3. Setting monitor mode \n```python\nimport wirelesswizard\n\n# selecting an interface\ninterfaces = wirelesswizard.get_wireless_interfaces()\ninterface = interfaces[0]\n\n# changing interface to monitor mode\ninterface.change_mode(\"monitor\")\n```\n### 4. Changing state\n```python\nimport wirelesswizard\n\n# selecting an interface\ninterfaces = wirelesswizard.get_wireless_interfaces()\ninterface = interfaces[0]\n\n# executing ip link set <iface> down\ninterface.change_state(\"down\")\n\n# executing ip link set <iface> up\ninterface.change_state(\"up\")\n```\n### 5. Changing\n```python\nimport wirelesswizard\n\n# selecting an interface\ninterfaces = wirelesswizard.get_wireless_interfaces()\ninterface = interfaces[0]\n\n# changing to channel 11\ninterface.change_channel(11)\n```\n## License\nThis proyect is under GPL v3 license.\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Simple wireless interface handler",
"version": "0.1.1a0",
"project_urls": {
"Homepage": "https://github.com/mind2hex/wirelesswizard"
},
"split_keywords": [
"wireless",
" interface",
" wifi",
" monitor",
" linux",
" iw",
" iwconfig",
" ifconfig"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "10d68eae451e07cfd6fcfe1ecc360695a108bcb96f1dd83776e78155e5e81e82",
"md5": "77233bf20a6f5d9429fecd23281a2215",
"sha256": "4342099e498132c82f667d0cc5a931a364f7e67be497d4fef6f27c8c19ed2f67"
},
"downloads": -1,
"filename": "wirelesswizard-0.1.1a0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "77233bf20a6f5d9429fecd23281a2215",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 21896,
"upload_time": "2024-05-01T23:06:52",
"upload_time_iso_8601": "2024-05-01T23:06:52.397406Z",
"url": "https://files.pythonhosted.org/packages/10/d6/8eae451e07cfd6fcfe1ecc360695a108bcb96f1dd83776e78155e5e81e82/wirelesswizard-0.1.1a0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2840923b8ce4dbddc3556da4638fb1504be495f05cc39782489707fc310b37cd",
"md5": "c97b561fbe0ed0a8f3fff3531bd1304f",
"sha256": "ba618305e51c54510ca52ae28b450222570dc982b4fece4f88084e85b39a9cf9"
},
"downloads": -1,
"filename": "wirelesswizard-0.1.1a0.tar.gz",
"has_sig": false,
"md5_digest": "c97b561fbe0ed0a8f3fff3531bd1304f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 22309,
"upload_time": "2024-05-01T23:06:53",
"upload_time_iso_8601": "2024-05-01T23:06:53.463681Z",
"url": "https://files.pythonhosted.org/packages/28/40/923b8ce4dbddc3556da4638fb1504be495f05cc39782489707fc310b37cd/wirelesswizard-0.1.1a0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-01 23:06:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mind2hex",
"github_project": "wirelesswizard",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wirelesswizard"
}
JSON
