Skip to content

Commit 5666c18

Browse files
committed
docs: Make all quickstart code snippets a valid scripts
Otherwise it might be confusing on where the variables come from.
1 parent 76b9141 commit 5666c18

File tree

1 file changed

+39
-5
lines changed

1 file changed

+39
-5
lines changed

docs/quickstart.rst

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,18 @@ can be used to determine particular type of a device.
4242

4343
.. code-block:: python
4444
45-
from sdbus_block.networkmanager import NetworkDeviceGeneric, NetworkDeviceWireless
45+
import sdbus
46+
47+
from sdbus_block.networkmanager import (
48+
NetworkDeviceGeneric,
49+
NetworkDeviceWireless,
50+
NetworkManager,
51+
)
4652
from sdbus_block.networkmanager.enums import DeviceType
4753
54+
sdbus.set_default_bus(sdbus.sd_bus_open_system())
55+
network_manager = NetworkManager()
56+
4857
all_devices = {path: NetworkDeviceGeneric(path) for path in network_manager.devices}
4958
5059
wifi_devices = [
@@ -67,11 +76,22 @@ class.
6776

6877
.. code-block:: python
6978
70-
from sdbus_block.networkmanager import NetworkManagerSettings
79+
import sdbus
80+
81+
from sdbus_block.networkmanager import (
82+
NetworkConnectionSettings,
83+
NetworkManager,
84+
NetworkManagerSettings,
85+
)
86+
87+
sdbus.set_default_bus(sdbus.sd_bus_open_system())
88+
network_manager = NetworkManager()
7189
7290
networwork_manager_settings = NetworkManagerSettings()
7391
74-
all_connections = [NetworkConnectionSettings(x) for x in networwork_manager_settings.connections]
92+
all_connections = [
93+
NetworkConnectionSettings(x) for x in networwork_manager_settings.connections
94+
]
7595
7696
The actual connection settings are represented by a complex double nested dictionary
7797
of D-Bus variants. For convenience a `dataclass <https://docs.python.org/3/library/dataclasses.html>`_
@@ -83,9 +103,23 @@ are two main methods to interact with connection settings helper.
83103

84104
.. code-block:: python
85105
86-
connection = all_connections[0]
106+
import sdbus
107+
108+
from sdbus_block.networkmanager import (
109+
NetworkConnectionSettings,
110+
NetworkManager,
111+
NetworkManagerSettings,
112+
)
113+
114+
sdbus.set_default_bus(sdbus.sd_bus_open_system())
115+
network_manager = NetworkManager()
116+
117+
networwork_manager_settings = NetworkManagerSettings()
118+
119+
120+
connection = NetworkConnectionSettings(networwork_manager_settings.connections[0])
87121
setting_dataclass = connection.get_profile()
88-
print("uuid:", profile.connection.uuid)
122+
print("uuid:", setting_dataclass.connection.uuid)
89123
90124
Active Connection
91125
-----------------

0 commit comments

Comments
 (0)