v1: Remove _async suffix from all methods, remove fire-n-forget counterparts, code improvements (#10)

* configs

* remove fire-and-forget methods | remove _async in methods name

* updates

* update test file

* fix examples

Author: ndonkoHenri

.ci/patch_pubspec_version.py

@@ -1,3 +1,7 @@
+# /// script
+# dependencies = ["pyyaml"]
+# ///
+
 import os
 import pathlib
 import sys
@@ -17,7 +21,7 @@
     "flet",
 ]
 
-with open(pubspec_path, "r") as f:
+with open(pubspec_path) as f:
     data = yaml.safe_load(f)
 
     # patch version

.ci/patch_toml_version.py

@@ -1,3 +1,7 @@
+# /// script
+# dependencies = ["tomlkit"]
+# ///
+
 import os
 import pathlib
 import sys
@@ -14,7 +18,7 @@
 print(f"Patching TOML file {toml_path} to {ver}")
 
 # read
-with open(toml_path, "r") as f:
+with open(toml_path) as f:
     t = tomlkit.parse(f.read())
 
 # patch version

.docstr.yaml

@@ -0,0 +1,7 @@
+paths: src/flet_audio
+badge: ./docs/assets/badges/docs-coverage.svg
+skip_file_doc: True
+skip_private: False
+ignore_patterns: # Dict with key/value pairs of file-pattern/node-pattern
+  .*: __post_init__  # Ignore __post_init__ in all files
+fail_under: 50

.github/workflows/docs.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches:
       - main
-      - dev
     paths:
       - 'LICENSE'
       - 'CHANGELOG.md'

CHANGELOG.md

@@ -23,14 +23,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
     - `on_duration_changed` → `on_duration_change`
     - `on_position_changed` → `on_position_change`
 - Method `Audio.play()` now accepts an optional `position` parameter for specifying start position.
-- The following sync methods were removed:
-    - `get_duration()` → use `get_duration_async()` instead
-    - `get_current_position()` → use `get_current_position_async()` instead
+- The following sync methods were made [`async`](https://docs.python.org/3/library/asyncio.html):
+    - `get_duration()`
+    - `get_current_position()`
 
 ## [0.1.0] - 2025-01-15
 
 Initial release.
 
 
 [0.2.0]: https://github.com/flet-dev/flet-audio/compare/0.1.0...0.2.0
-[0.1.0]: https://github.com/flet-dev/flet-audio/releases/tag/0.1.0
+[0.1.0]: https://github.com/flet-dev/flet-audio/releases/tag/0.1.0

README.md

@@ -25,7 +25,9 @@ This package supports the following platforms:
 | Android  |     ✅     |
 | Web      |     ✅     |
 
-## Installation
+## Usage
+
+### Installation
 
 To install the `flet-audio` package and add it to your project dependencies:
 
@@ -45,6 +47,6 @@ To install the `flet-audio` package and add it to your project dependencies:
     poetry add flet-audio
     ```
 
-## Examples
+### Examples
 
-For examples, see [this](./examples)
+For examples, see [these](./examples).

appveyor.yml

@@ -3,23 +3,20 @@ image: ubuntu
 version: '0.1.{build}'
 
 environment:
+  PYTHON_VERSION: 3.12
   UV_PUBLISH_TOKEN:
     secure: 174ncAbF5IjSIkmioPt62jeSnzmTlRNchUkE4QdjDWH8xK1olYtySXLJpo2q95HcP7lWJky1hv4APESiRRHnBWoY0XRFafzM/mbCDMzG1tZXiXZmpP1qzHAtRP2QSCIg18xh1TMktraUdTi7sbJnjjRhqzgbW1k0kLBxKw79MPFBhYQ/TiGcmaYWZbWVZNY3HCUCb6Dt7bG1OE2Ul9rD1gvs55xwO9Oq9FOVA1VnMYw=
 
-stack:
-- python 3.12
-
 install:
 - source .ci/update_build_version.sh
-- python --version
-- python -m ensurepip --upgrade
-- pip3 install --upgrade tomlkit pyyaml
 - curl -LsSf https://astral.sh/uv/install.sh | sh
-- export PATH=$HOME/.local/bin:$PATH
+- export PATH="$HOME/.local/bin:$PATH"
+- uv python install $PYTHON_VERSION
+- uv python pin $PYTHON_VERSION
 
 build_script:
-- python .ci/patch_toml_version.py pyproject.toml $PYPI_VER
-- python .ci/patch_pubspec_version.py src/flutter/flet_*/pubspec.yaml $PKG_VER
+- uv run .ci/patch_toml_version.py pyproject.toml $PYPI_VER
+- uv run .ci/patch_pubspec_version.py src/flutter/flet_*/pubspec.yaml $PKG_VER
 - (cd src/flutter/* && dart pub get && dart analyze && cd -)
 - uv build
 
@@ -32,4 +29,4 @@ deploy_script:
 artifacts:
 - path: dist/*.whl
 
-test: off
+test: off

docs/audio.md

@@ -1 +1,7 @@
-::: flet_audio.Audio
+## Examples
+
+```python title="example_1.py"
+--8<-- "examples/audio_example/src/example_1.py"
+```
+
+::: flet_audio.Audio

docs/index.md

@@ -46,18 +46,16 @@ To install the `flet-audio` package and add it to your project dependencies:
 
 ??? note "Windows Subsystem for Linux (WSL)"
     On WSL, you need to install [`GStreamer`](https://github.com/GStreamer/gstreamer) library.
-    
-    If you receive `error while loading shared libraries: libgstapp-1.0.so.0`, 
+
+    If you receive `error while loading shared libraries: libgstapp-1.0.so.0`,
     it means `GStreamer` is not installed in your WSL environment.
-    
+
     To install it, run the following command:
-    
+
     ```bash
     apt install -y libgstreamer1.0-0 gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly gstreamer1.0-libav gstreamer1.0-tools
     ```
 
-## Example
+### Examples
 
-```python title="main.py"
---8<-- "examples/audio_example/src/main.py"
-``` 
+See [these](audio.md#examples).

examples/audio_example/src/example_1.py

@@ -0,0 +1,74 @@
+import flet as ft
+
+import flet_audio as fta
+
+
+def main(page: ft.Page):
+    url = "https://github.com/mdn/webaudio-examples/blob/main/audio-analyser/viper.mp3?raw=true"
+
+    async def play(e: ft.Event[ft.ElevatedButton]):
+        await audio.play()
+
+    async def pause(e: ft.Event[ft.ElevatedButton]):
+        await audio.pause()
+
+    async def resume(e: ft.Event[ft.ElevatedButton]):
+        await audio.resume()
+
+    async def release(e: ft.Event[ft.ElevatedButton]):
+        await audio.release()
+
+    def set_volume(value: float):
+        audio.volume += value
+
+    def set_balance(value: float):
+        audio.balance += value
+
+    async def seek_2s(e: ft.Event[ft.ElevatedButton]):
+        await audio.seek(ft.Duration(seconds=2))
+
+    async def get_duration(e: ft.Event[ft.ElevatedButton]):
+        duration = await audio.get_duration()
+        print("Duration:", duration)
+
+    async def on_get_current_position(e: ft.Event[ft.ElevatedButton]):
+        position = await audio.get_current_position()
+        print("Current position:", position)
+
+    audio = fta.Audio(
+        src=url,
+        autoplay=False,
+        volume=1,
+        balance=0,
+        on_loaded=lambda _: print("Loaded"),
+        on_duration_change=lambda e: print("Duration changed:", e.duration),
+        on_position_change=lambda e: print("Position changed:", e.position),
+        on_state_change=lambda e: print("State changed:", e.state),
+        on_seek_complete=lambda _: print("Seek complete"),
+    )
+    page.services.append(audio)
+
+    page.add(
+        ft.ElevatedButton("Play", on_click=play),
+        ft.ElevatedButton("Pause", on_click=pause),
+        ft.ElevatedButton("Resume", on_click=resume),
+        ft.ElevatedButton("Release", on_click=release),
+        ft.ElevatedButton("Seek 2s", on_click=seek_2s),
+        ft.Row(
+            controls=[
+                ft.ElevatedButton("Volume down", on_click=lambda _: set_volume(-0.1)),
+                ft.ElevatedButton("Volume up", on_click=lambda _: set_volume(0.1)),
+            ]
+        ),
+        ft.Row(
+            controls=[
+                ft.ElevatedButton("Balance left", on_click=lambda _: set_balance(-0.1)),
+                ft.ElevatedButton("Balance right", on_click=lambda _: set_balance(0.1)),
+            ]
+        ),
+        ft.ElevatedButton("Get duration", on_click=get_duration),
+        ft.ElevatedButton("Get current position", on_click=on_get_current_position),
+    )
+
+
+ft.run(main)