pywifi

pywifi provides a cross-platform Python module for manipulating wireless interfaces.

• Easy to use
• Supports Windows and Linux

Prerequisites

On Linux, you will need to run wpa_supplicant to manipulate the wifi devices, and then pywifi can communicate with wpa_supplicant through socket.

On Windows, the Native Wifi component comes with Windows versions greater than Windows XP SP2.

Installation

After installing the prerequisites listed above for your platform, you can use pip to install from source:

cd pywifi/
pip install .

CLI Usage

pywifi now includes a command-line interface for convenient WiFi management:

List available WiFi interfaces

pywifi list-interfaces

Scan for networks

pywifi scan

Connect to a network

# Open network
pywifi connect "Network-Name"

# Secured network (WPA2-PSK)
pywifi connect "Network-Name" --password "your-password"

Disconnect from current network

pywifi disconnect

Check interface status

pywifi status

Get help

pywifi --help
pywifi scan --help
pywifi connect --help

For more CLI options, use the --help flag with any command.

Documentation

For the details of pywifi, please refer to Documentation.

Example

import time
import pywifi
from pywifi import const

wifi = pywifi.PyWiFi()

iface = wifi.interfaces()[0]

iface.disconnect()
time.sleep(1)
assert iface.status() in\
    [const.IFACE_DISCONNECTED, const.IFACE_INACTIVE]

profile = pywifi.Profile()
profile.ssid = 'testap'
profile.auth = const.AUTH_ALG_OPEN
profile.akm.append(const.AKM_TYPE_WPA2PSK)
profile.cipher = const.CIPHER_TYPE_CCMP
profile.key = '12345678'

iface.remove_all_network_profiles()
tmp_profile = iface.add_network_profile(profile)

iface.connect(tmp_profile)
time.sleep(30)
assert iface.status() == const.IFACE_CONNECTED

iface.disconnect()
time.sleep(1)
assert iface.status() in\
    [const.IFACE_DISCONNECTED, const.IFACE_INACTIVE]

(C) Jiang Sheng-Jhih 2019, MIT License.