https://github.com/gruvw/nmwifi

Python API (and CLI) to configure a Wi-Fi device through NetworkManager using a fallback Access Point.
https://github.com/gruvw/nmwifi

ap api network-manager networking wifi

Last synced: 17 days ago
JSON representation

Python API (and CLI) to configure a Wi-Fi device through NetworkManager using a fallback Access Point.

• Host: GitHub
• URL: https://github.com/gruvw/nmwifi
• Owner: gruvw
• Created: 2024-06-14T12:36:27.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-07-31T00:52:43.000Z (5 months ago)
• Last Synced: 2024-12-15T03:43:12.928Z (22 days ago)
• Topics: ap, api, network-manager, networking, wifi
• Language: Python
• Homepage: https://pypi.org/project/nmwifi
• Size: 51.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Roadmap: docs/roadmap.md

Awesome Lists containing this project

README

        
# nmwifi

The [Python](https://www.python.org) package `nmwifi` provides an API (and a CLI) to configure a Wi-Fi device through [NetworkManager](https://networkmanager.dev/) using a fallback Access Point.

Take a look at the project's [roadmap](docs/roadmap.md) to see upcoming features (and all the work accomplished).

**Note** - Check out the `nmwifi` python package on PyPI:  (managed using [Poetry](https://python-poetry.org/)).

This package was initially developed for the [Raspberry Pi](https://raspberrypi.com) to headlessly set up a Wi-Fi connection to a home router. 

However it works for any device that has at least one wireless network interface and that has NetworkManager installed.

## Installation

- Install by running: `pip install nmwifi`

- Usage: `nmwifi --help`

### Basic usage

The most common usage of the `nmwifi` tool is to first call `setup` (to configure the connections) and then keep the `balance` loop running forever.

This will set up a Wi-Fi connection to the given SSID and password along with an Access Point (with default SSID and no password).

When the Wi-Fi network is not available, NetworkManager will automatically switch to the Access Point (AP).

The balance loop will periodically try to reconnect to the Wi-Fi network on AP mode.

**Note**: the synchronous calls can take some time to respond depending on the underlying NetworkManager behavior.

List every network interface on your machine by running the `nmcli d` command, select one that has the "wifi" type (often `wlan0`).

#### CLI

```bash

nmwifi setup -i  -ws  -wp 

nmwifi balance -i 

```

#### Python

```python

import nmwifi

nmwifi.setup("", "", "")

nmwifi.balance("")

```

## Contributions

Feel free to contribute by submitting pull requests, whether to add new features, improve existing functionality, or fix bugs :)

Before opening a new PR, make sure to open an issue to discuss it beforehand (first check if a similar issue does not already exist).

## Powered by

This project would not be possible without the wonderful technologies below:

* [Python](https://www.python.org/)

* [NetworkManager](https://networkmanager.dev/)