Skip to content

Commit

Permalink
delegate to bluechi
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Engel <[email protected]>
  • Loading branch information
engelmi committed Sep 5, 2023
1 parent 93774b8 commit 648ed7e
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 653 deletions.
46 changes: 2 additions & 44 deletions src/bindings/python/README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,3 @@
# BlueChi Python bindings
# hirte 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)
```
The hirte python bindings are deprecated. Please use [bluechi](https://pypi.org/project/bluechi/) instead.
Loading

0 comments on commit 648ed7e

Please sign in to comment.