https://github.com/awkman/pywifi

A cross-platform module for manipulating WiFi devices.
https://github.com/awkman/pywifi

Last synced: 3 months ago
JSON representation

A cross-platform module for manipulating WiFi devices.

• Host: GitHub
• URL: https://github.com/awkman/pywifi
• Owner: awkman
• License: mit
• Created: 2016-06-18T07:43:12.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-10-27T03:31:30.000Z (about 1 year ago)
• Last Synced: 2024-07-19T02:33:25.225Z (4 months ago)
• Language: Python
• Size: 72.3 KB
• Stars: 439
• Watchers: 20
• Forks: 152
• Open Issues: 49
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pywifi

![](https://img.shields.io/pypi/pyversions/pywifi.svg)

[![Build Status](https://travis-ci.com/awkman/pywifi.svg?branch=master)](https://travis-ci.com/awkman/pywifi)

[![PyPI version](https://badge.fury.io/py/pywifi.svg)](https://badge.fury.io/py/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 .

## 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].

[Native Wifi]: https://msdn.microsoft.com/en-us/library/windows/desktop/ms706556.aspx

[MIT License]: https://opensource.org/licenses/MIT

[Documentation]: https://github.com/awkman/pywifi/blob/master/DOC.md