Metadata-Version: 2.1
Name: bluechi
Version: 0.5.0
Summary: Python bindings for BlueChi's D-Bus API
Home-page: https://github.com/containers/bluechi/
Author: BlueChi developers
License: LGPL-2.1-or-later
Description: # BlueChi Python bindings
        
        The BlueChi Python bindings provides a Python module to interact with the D-Bus API of BlueChi. It consists of the
        following subpackages:
        
        - `api`: auto-generated code based the BlueChi D-BUS API description
        - `ext`: custom written code to simplify common tasks
        
        ## Installation
        
        Using `pip3`:
        
        ```sh
        # from PyPi
        pip3 install bluechi
        # or from cloned git repo
        pip3 install --force dist/bluechi-<version>-py3-none-any.whl
        ```
        
        ## Examples
        
        Listing all connected nodes and their current state:
        
        ```python
        from bluechi.api import Manager
        
        for node in Manager().list_nodes():
            # node[name, obj_path, status]
            print(f"Node: {node[0]}, State: {node[3]}")
        ```
        
        Starting and stopping of a systemd unit on a specific node using the `Unit` class from the `ext` subpackage to
        implicitly wait for the job to finish:
        
        ```python
        from bluechi.ext import Unit
        
        hu = Unit("my-node-name")
        
        result = hu.start_unit("chronyd.service")
        print(result)
        
        result = hu.stop_unit("chronyd.service")
        print(result)
        ```
        
Keywords: bluechi,python,D-Bus,systemd
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
