https://github.com/rytilahti/python-ubus

Python library for accessing ubus over JSON-RPC
https://github.com/rytilahti/python-ubus

ddwrt json-rpc openwrt python ubus

Last synced: 2 months ago
JSON representation

Python library for accessing ubus over JSON-RPC

• Host: GitHub
• URL: https://github.com/rytilahti/python-ubus
• Owner: rytilahti
• Created: 2017-06-05T19:39:05.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-05-22T22:58:25.000Z (over 6 years ago)
• Last Synced: 2024-10-03T13:42:43.868Z (3 months ago)
• Topics: ddwrt, json-rpc, openwrt, python, ubus
• Language: Python
• Size: 13.7 KB
• Stars: 17
• Watchers: 3
• Forks: 9
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

        
Python interface for Ubus

=========================

This package provides a pythonic interface for accessing

`ubus ` over its

separately packaged JSON-RPC interface.

Library use

===========

Ubus class is the entrypoint to access all functionalities of this

package, which provides an access to the available interfaces:

::

    ubus = Ubus('router.local')

    for iface in ubus.interfaces:

        print(iface)

Besides iterator interface the interfaces can be accessed with a

dict-style accessors, which also return ``UbusNamespace`` objects for

accessing the underlying methods.

::

    dhcp = ubus['dhcp']

    for method in dhcp:

         print(method)

``UbusMethod`` class implement ``__call__`` to allow easy execution of

methods:

::

    v4leases = dhcp['ipv4leases']()

Where required, the parameters are passed as dictionaries:

::

    ubus['session']['login'](username='user', password='1234')

Context manager support

-----------------------

Ubus constructor accepts username and password as parameters, which in

turn allows using the class as a context-manager to simplify session

handling:

::

    with Ubus('router.local', 'user', '1234') as ubus:

        wlan0_devices = ubus['iwinfo']['assoclist'](device='wlan0')

Command-line utility

====================

There is also a simple command-line interface (similar to ubus

command-line tool) called pyubus, which enables running arbitrary

commands from the console. When no parameters are given it will output

the list of available namespaces (calls implicitly list command, more

information in --help). All unknown commands are interpreted as

namespaces names, so listing all available methods in namespace 'dhcp'

can be done by simply calling:

::

    $ pyubus dhcp

Methods can be directly executed by passing their name, and potential

parameters in ``key=value`` format to the utility:

::

    $ pyubus iwinfo assoclist device=wlan0

Configuration can be either passed as options or through creating an

ini-style configuration file in ~/.config/python-ubus.ini:

::

    [ubus]

    host = router.local

    username = user

    password = 1234