Metadata-Version: 2.1
Name: openwrt-ubus-rpc
Version: 0.0.2
Summary: OpenWrt ubus RPC API library
Home-page: https://github.com/Noltari/python-ubus-rpc
Author: noltari
Author-email: noltari@gmail.com
License: GPL2
Keywords: api,openwrt,ubus
Platform: any
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Topic :: Home Automation
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
License-File: LICENSE.md
Requires-Dist: requests
Requires-Dist: urllib3

openwrt-ubus-rpc is a Python module implementing an interface to the OpenWrt ubus RPC API.  
It allows a user to perform Remote Procedure Calls (RPC) to the OpenWrt micro bus architecture (ubus).

Documentation for the OpenWrt ubus RPC API is available at https://openwrt.org/docs/techref/ubus and https://openwrt.org/docs/guide-developer/ubus.

This package has been developed to be used with https://home-assistant.io/ but it can be used in other contexts.

Disclaimer
----------

openwrt-ubus-rpc was created for my own use, and for others who may wish to experiment with personal Internet of Things systems.

This software is provided without warranty, according to the GNU Public Licence version 2, and should therefore not be used where it may endanger life, financial stakes or cause discomfort and inconvenience to others.

Usage
-----

```
from openwrt.ubus import Ubus
_ubus = Ubus(host="http://openwrt_host/ubus", user="openwrt_user", password="openwrt_password")
_ubus.connect()
_ubus.get_hostapd()
_ubus.get_hostapd_clients("hostapd.wlan0")
```