Merge pull request #9 from tokyob0t/main

Added examples for python and lua to the docs :nerd_face: 

12 files changed, 205 insertions, 53 deletions

diff --git a/docs/libraries/apps.md b/docs/libraries/apps.md
index f19a70a..c53daf0 100644
--- a/docs/libraries/apps.md
+++ b/docs/libraries/apps.md
@@ -70,17 +70,35 @@ const apps = new Apps.Apps({
     includeExecutable: true,
 })
 
-print(apps.fuzzy_query("spotify")
-    .map(app => app.name)
-    .join("\n"))
+for (const app of apps.fuzzy_query("spotify")) {
+    print(app.name)
+}
 ```
 
 ```py [<i class="devicon-python-plain"></i> Python]
-# Not yet documented, contributions are appreciated
+from gi.repository import AstalApps as Apps
+
+apps = Apps.Apps(
+    include_entry=True,
+    include_executable=True,
+)
+
+for app in apps.fuzzy_query("obsidian"):
+    print(app.get_name())
+
 ```
 
 ```lua [<i class="devicon-lua-plain"></i> Lua]
--- Not yet documented, contributions are appreciated
+local Apps = require("lgi").require("AstalApps")
+
+local apps = Apps.Apps({
+    include_entry = true,
+    include_executable = true,
+})
+
+for _, app in ipairs(apps:fuzzy_query("lutris")) do
+    print(app.name)
+end
 ```
 
 ```vala [<i class="devicon-vala-plain"></i> Vala]
diff --git a/docs/libraries/auth.md b/docs/libraries/auth.md
index a699404..1f07a17 100644
--- a/docs/libraries/auth.md
+++ b/docs/libraries/auth.md
@@ -73,22 +73,42 @@ astal-auth --password my-password
 :::code-group
 
 ```js [<i class="devicon-javascript-plain"></i> JavaScript]
-import Auth from "gi://AstalAuth";
-import Gio from "gi://Gio";
-
-Gio._promisify(Auth.Pam, "authenticate");
-
-await Auth.Pam.authenticate("password")
-    .then(_ => print("authentication sucessful"))
-    .catch(logError);
+import Auth from "gi://AstalAuth"
+
+Auth.Pam.authenticate("password", (_, task) => {
+    try {
+        AstalAuth.Pam.authenticate_finish(task)
+        print("authentication sucessful")
+    } catch (error) {
+        print(error)
+    }
+})
 ```
 
 ```py [<i class="devicon-python-plain"></i> Python]
-# Not yet documented
+from gi.repository import AstalAuth as Auth
+
+def callback(_, task) -> None:
+    try:
+        Auth.Pam.authenticate_finish(task)
+        print("success")
+    except Exception as e:
+        print(e)
+
+Auth.Pam.authenticate("password", callback)
 ```
 
 ```lua [<i class="devicon-lua-plain"></i> Lua]
--- Not yet documented
+local Auth = require("lgi").require("AstalAuth")
+
+Auth.Pam.authenticate("password", function(_, task)
+    local status, err = Auth.Pam.authenticate_finish(task)
+    if err ~= nil then
+        print(err)
+    else
+        print("success")
+    end
+end)
 ```
 
 ```vala [<i class="devicon-vala-plain"></i> Vala]
diff --git a/docs/libraries/battery.md b/docs/libraries/battery.md
index 4a48b96..5c2c79f 100644
--- a/docs/libraries/battery.md
+++ b/docs/libraries/battery.md
@@ -67,19 +67,27 @@ astal-battery --help
 :::code-group
 
 ```js [<i class="devicon-javascript-plain"></i> JavaScript]
-import Battery from "gi://AstalBattery";
+import Battery from "gi://AstalBattery"
 
 const battery = Battery.get_default()
 
-console.log(battery.percentage)
+print(battery.percentage)
 ```
 
 ```py [<i class="devicon-python-plain"></i> Python]
-# Not yet documented
+from gi.repository import AstalBattery as Battery
+
+battery = Battery.get_default()
+
+print(battery.get_percentage())
 ```
 
 ```lua [<i class="devicon-lua-plain"></i> Lua]
--- Not yet documented
+local Battery = require("lgi").require("AstalBattery")
+
+local battery = Battery.get_default()
+
+print(battery.percentage)
 ```
 
 ```vala [<i class="devicon-vala-plain"></i> Vala]
diff --git a/docs/libraries/bluetooth.md b/docs/libraries/bluetooth.md
index 9aa7de7..04d9db2 100644
--- a/docs/libraries/bluetooth.md
+++ b/docs/libraries/bluetooth.md
@@ -69,19 +69,32 @@ bluetoothctl --help
 :::code-group
 
 ```js [<i class="devicon-javascript-plain"></i> JavaScript]
-import Bluetooth from "gi://AstalBluetooth";
+import Bluetooth from "gi://AstalBluetooth"
 
 const bluetooth = Bluetooth.get_default()
 
-console.log(bluetooth.get_devices().map(d => d.name))
+for (const device of bluetooth.get_devices()) {
+    print(device.name)
+}
 ```
 
 ```py [<i class="devicon-python-plain"></i> Python]
-# Not yet documented
+from gi.repository import AstalBluetooth as Bluetooth
+
+bluetooth = Bluetooth.get_default()
+
+for device in bluetooth.get_devices():
+    print(device.get_name())
 ```
 
 ```lua [<i class="devicon-lua-plain"></i> Lua]
--- Not yet documented
+local Bluetooth = require("lgi").require("AstalBluetooth")
+
+local bluetooth = Bluetooth.get_default()
+
+for _, d in ipairs(bluetooth.devices) do
+    print(d.name)
+end
 ```
 
 ```vala [<i class="devicon-vala-plain"></i> Vala]
diff --git a/docs/libraries/hyprland.md b/docs/libraries/hyprland.md
index 0bc20c4..faf9e50 100644
--- a/docs/libraries/hyprland.md
+++ b/docs/libraries/hyprland.md
@@ -62,19 +62,32 @@ astal-hyprland # starts monitoring
 :::code-group
 
 ```js [<i class="devicon-javascript-plain"></i> JavaScript]
-import Hyprland from "gi://AstalHyprland";
+import Hyprland from "gi://AstalHyprland"
 
 const hyprland = Hyprland.get_default()
 
-console.log(hyprland.get_clients().map(c => c.title))
+for (const client of hyprland.get_clients()) {
+    print(client.title)
+}
 ```
 
 ```py [<i class="devicon-python-plain"></i> Python]
-# Not yet documented
+from gi.repository import AstalHyprland as Hyprland
+
+hyprland = Hyprland.get_default()
+
+for client in hyprland.get_clients():
+    print(client.get_title())
 ```
 
 ```lua [<i class="devicon-lua-plain"></i> Lua]
--- Not yet documented
+local Hyprland = require("lgi").require("AstalHyprland")
+
+local hyprland = Hyprland.get_default()
+
+for _, c in ipairs(hyprland.clients) do
+    print(c.title)
+end
 ```
 
 ```vala [<i class="devicon-vala-plain"></i> Vala]
diff --git a/docs/libraries/mpris.md b/docs/libraries/mpris.md
index d277b24..b4f30ca 100644
--- a/docs/libraries/mpris.md
+++ b/docs/libraries/mpris.md
@@ -66,20 +66,31 @@ astal-mpris --help
 :::code-group
 
 ```js [<i class="devicon-javascript-plain"></i> JavaScript]
-import Mpris from "gi://AstalMpris";
+import Mpris from "gi://AstalMpris"
 
 const spotify = Mpris.Player.new("spotify")
 
 if (spotify.available)
-    console.log(spotify.title)
+    print(spotify.title)
 ```
 
 ```py [<i class="devicon-python-plain"></i> Python]
-# Not yet documented
+from gi.repository import AstalMpris as Mpris
+
+spotify = Mpris.Player.new("spotify")
+
+if spotify.get_available():
+    print(spotify.get_title())
 ```
 
 ```lua [<i class="devicon-lua-plain"></i> Lua]
--- Not yet documented
+local Mpris = require("lgi").require("AstalMpris")
+
+local Mpris = Mpris.Player.new("spotify")
+
+if spotify.available then
+    print(spotify.title)
+end
 ```
 
 ```vala [<i class="devicon-vala-plain"></i> Vala]
diff --git a/docs/libraries/network.md b/docs/libraries/network.md
index 7f6b883..cd10f4f 100644
--- a/docs/libraries/network.md
+++ b/docs/libraries/network.md
@@ -64,19 +64,27 @@ nmcli --help
 :::code-group
 
 ```js [<i class="devicon-javascript-plain"></i> JavaScript]
-import Network from "gi://AstalNetwork";
+import Network from "gi://AstalNetwork"
 
 const network = Network.get_default()
 
-console.log(network.wifi.ssid)
+print(network.wifi.ssid)
 ```
 
 ```py [<i class="devicon-python-plain"></i> Python]
-# Not yet documented
+from gi.repository import AstalNetwork as Network
+
+network = Network.get_default()
+
+print(network.get_wifi().get_ssid())
 ```
 
 ```lua [<i class="devicon-lua-plain"></i> Lua]
--- Not yet documented
+local Network = require("lgi").require("AstalNetwork")
+
+local network = Network.get_default()
+
+print(network.wifi.ssid)
 ```
 
 ```vala [<i class="devicon-vala-plain"></i> Vala]
diff --git a/docs/libraries/notifd.md b/docs/libraries/notifd.md
index 2ba0b7b..7e02149 100644
--- a/docs/libraries/notifd.md
+++ b/docs/libraries/notifd.md
@@ -66,22 +66,37 @@ astal-notifd --help
 :::code-group
 
 ```js [<i class="devicon-javascript-plain"></i> JavaScript]
-import Notifd from "gi://AstalNotifd";
+import Notifd from "gi://AstalNotifd"
 
 const notifd = Notifd.get_default()
 
 notifd.connect("notified", (_, id) => {
     const n = notifd.get_notification(id)
-    console.log(n.summary, n.body)
+    print(n.summary, n.body)
 })
 ```
 
 ```py [<i class="devicon-python-plain"></i> Python]
-# Not yet documented
+from gi.repository import AstalNotifd as Notifd
+
+notifd = Notifd.get_default()
+
+def on_notified(_, id):
+    n = notifd.get_notification(id)
+    print(n.get_body(), n.get_body())
+
+notifd.connect("notified", on_notified)
 ```
 
 ```lua [<i class="devicon-lua-plain"></i> Lua]
--- Not yet documented
+local Notifd = require("lgi").require("AstalNotifd")
+
+local notifd = Notifd.get_default()
+
+notifd.on_notified = function(_, id)
+    local n = notifd.get_notification(id)
+    print(n.body, n.summary)
+end
 ```
 
 ```vala [<i class="devicon-vala-plain"></i> Vala]
diff --git a/docs/libraries/powerprofiles.md b/docs/libraries/powerprofiles.md
index a722c3d..8571c29 100644
--- a/docs/libraries/powerprofiles.md
+++ b/docs/libraries/powerprofiles.md
@@ -67,19 +67,27 @@ astal-power-profiles --help
 :::code-group
 
 ```js [<i class="devicon-javascript-plain"></i> JavaScript]
-import PowerProfiles from "gi://AstalPowerProfiles";
+import PowerProfiles from "gi://AstalPowerProfiles"
 
 const powerprofiles = PowerProfiles.get_default()
 
-console.log(powerprofiles.activeProfile)
+print(powerprofiles.activeProfile)
 ```
 
 ```py [<i class="devicon-python-plain"></i> Python]
-# Not yet documented
+from gi.repository import AstalPowerProfiles as PowerProfiles
+
+powerprofiles = PowerProfiles.get_default()
+
+print(powerprofiles.get_active_profile())
 ```
 
 ```lua [<i class="devicon-lua-plain"></i> Lua]
--- Not yet documented
+local PowerProfiles = require("lgi").require("AstalPowerProfiles")
+
+local powerprofiles = PowerProfiles.get_default()
+
+print(powerprofiles.active_profile)
 ```
 
 ```vala [<i class="devicon-vala-plain"></i> Vala]
diff --git a/docs/libraries/river.md b/docs/libraries/river.md
index 01f6ca4..4818d0b 100644
--- a/docs/libraries/river.md
+++ b/docs/libraries/river.md
@@ -62,15 +62,32 @@ astal-river --help
 :::code-group
 
 ```js [<i class="devicon-javascript-plain"></i> JavaScript]
-// Not yet documented
+import River from "gi://AstalRiver"
+
+const river = River.get_default()
+
+for (const output of river.get_outputs()) {
+    print(output.name)
+}
 ```
 
 ```py [<i class="devicon-python-plain"></i> Python]
-# Not yet documented
+from gi.repository import AstalRiver as River
+
+river = River.get_default()
+
+for output in river.get_outputs():
+    print(output.get_name())
 ```
 
 ```lua [<i class="devicon-lua-plain"></i> Lua]
--- Not yet documented
+local River = require("lgi").require("AstalRiver")
+
+local river = River.River.get_default()
+
+for _, o in ipairs(river.outputs) do
+    print(o.name)
+end
 ```
 
 ```vala [<i class="devicon-vala-plain"></i> Vala]
diff --git a/docs/libraries/tray.md b/docs/libraries/tray.md
index 5868bd6..c8d093b 100644
--- a/docs/libraries/tray.md
+++ b/docs/libraries/tray.md
@@ -66,15 +66,28 @@ import Tray from "gi://AstalTray"
 
 const tray = Tray.get_default()
 
-console.log(tray.get_items().map(i => i.title))
+for (const item of tray.get_items()) {
+    print(item.title)
+}
 ```
 
 ```py [<i class="devicon-python-plain"></i> Python]
-# Not yet documented
+from gi.repository import AstalTray as Tray
+
+tray = Tray.get_default()
+
+for item in tray.get_items():
+    print(item.title)
 ```
 
 ```lua [<i class="devicon-lua-plain"></i> Lua]
--- Not yet documented
+local Tray = require("lgi").require("AstalTray")
+
+local tray = Tray.get_default()
+
+for _, i in ipairs(tray.items) do
+    print(i.title)
+end
 ```
 
 ```vala [<i class="devicon-vala-plain"></i> Vala]
diff --git a/docs/libraries/wireplumber.md b/docs/libraries/wireplumber.md
index e1c9579..7f02ab4 100644
--- a/docs/libraries/wireplumber.md
+++ b/docs/libraries/wireplumber.md
@@ -64,19 +64,27 @@ wpctl --help
 :::code-group
 
 ```js [<i class="devicon-javascript-plain"></i> JavaScript]
-import Wp from "gi://AstalWp";
+import Wp from "gi://AstalWp"
 
 const audio = Wp.get_default_wp().audio
 
-console.log(audio.volume)
+print(audio.default_speaker.volume)
 ```
 
 ```py [<i class="devicon-python-plain"></i> Python]
-# Not yet documented
+from gi.repository import AstalWp as Wp
+
+audio = Wp.get_default_wp().get_audio()
+
+print(audio.get_default_speaker().get_volume())
 ```
 
 ```lua [<i class="devicon-lua-plain"></i> Lua]
--- Not yet documented
+local Wp = require("lgi").require("AstalWp")
+
+local audio = Wp.get_default_wp().audio
+
+print(audio.default_speaker.volume)
 ```
 
 ```vala [<i class="devicon-vala-plain"></i> Vala]