Metadata-Version: 2.1
Name: unifi_ap
Version: 0.0.2
Summary: Python API for UniFi accesspoints
Author-email: Tobias Perschon <tobias@perschon.at>
Project-URL: Homepage, https://github.com/tofuSCHNITZEL/unifi_ap
Project-URL: Issues, https://github.com/tofuSCHNITZEL/unifi_ap/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: paramiko==3.5.0

# unifi_ap

Python API for UniFi accesspoints

## Installation

* pip install unifi_ap

## Usage

currently this package can only be used by importing it into own python files

```
import unifi_ap
ap = unifi_ap.UniFiAP("10.0.0.253", "admin")
clients = ap.get_clients()
ssids = ap.get_ssids()
clients_for_ssid = ap.get_clients(for_ssids=["guest"])
```

* Address/hostname and username are mandatory  
* if you don't define a password, ssh keys from the local ssh authentication agent are used  
* in addition/alternative to a password you can also define a private key file to be used for the authentication

`UniFiAP("10.0.0.253", "admin", keyfile="my-rsa.key")`

## Features

* get a list of SSIDs that the accesspoint is serving
* get currently connected clients (you can specify the SSIDs for which you want to get the clients - default: all)

## Credits

* inspired by https://pypi.org/project/unifi-tracker/

## License

[MIT](https://choosealicense.com/licenses/mit/)