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

* configs

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

* updates

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_recorder
+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

@@ -30,21 +30,21 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Recording configuration properties (`audio_encoder`, `suppress_noise`, `cancel_echo`, `auto_gain`, `channels_num`, `sample_rate`, `bit_rate`) are now grouped under `configuration: AudioRecorderConfiguration`
 - Event `on_state_changed` renamed to `on_state_change`
 - In all methods, parameter `wait_timeout` was renamed to `timeout`.
-- The following sync methods were removed from `AudioRecorder` (use corresponding async methods instead):
-    - `is_recording` → `is_recording_async`
-    - `stop_recording` → `stop_recording_async`
-    - `cancel_recording` → `cancel_recording_async`
-    - `resume_recording` → `resume_recording_async`
-    - `pause_recording` → `pause_recording_async`
-    - `is_paused` → `is_paused_async`
-    - `is_supported_encoder` → `is_supported_encoder_async`
-    - `get_input_devices` → `get_input_devices_async`
-    - `has_permission` → `has_permission_async`
+- The following `AudioRecorder` sync methods were made [`async`](https://docs.python.org/3/library/asyncio.html):
+    - `is_recording`
+    - `stop_recording`
+    - `cancel_recording`
+    - `resume_recording`
+    - `pause_recording`
+    - `is_paused`
+    - `is_supported_encoder`
+    - `get_input_devices`
+    - `has_permission`
 
 ## [0.1.0] - 2025-01-15
 
 Initial release.
 
 
 [0.2.0]: https://github.com/flet-dev/flet-audio-recorder/compare/0.1.0...0.2.0
-[0.1.0]: https://github.com/flet-dev/flet-audio-recorder/releases/tag/0.1.0
+[0.1.0]: https://github.com/flet-dev/flet-audio-recorder/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-recorder` package and add it to your project dependencies:
 
@@ -48,6 +50,6 @@ To install the `flet-audio-recorder` package and add it to your project dependen
 > [!NOTE]
 > On Linux, encoding is provided by [fmedia](https://stsaz.github.io/fmedia/) which must be installed separately.
 
-## 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_recorder.md

@@ -1 +1,9 @@
-::: flet_audio_recorder.audio_recorder.AudioRecorder
+## Examples
+
+### Example 1
+
+```python title="example_1.py"
+--8<-- "examples/audio_recorder_example/src/example_1.py"
+```
+
+::: flet_audio_recorder.audio_recorder.AudioRecorder

docs/index.md

@@ -36,7 +36,7 @@ To install the `flet-audio-recorder` package and add it to your project dependen
     ```bash
     pip install flet-audio-recorder  # (1)!
     ```
-    
+
     1. After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
 
 === "poetry"
@@ -47,9 +47,6 @@ To install the `flet-audio-recorder` package and add it to your project dependen
 ???+ note
     On Linux, encoding is provided by [fmedia](https://stsaz.github.io/fmedia/) which must be installed separately.
 
+### Examples
 
-## Example
-
-```python title="main.py"
---8<-- "examples/audio_recorder_example/src/main.py"
-```
+See [these](audio_recorder.md#examples).

examples/audio_recorder_example/src/example_1.py

@@ -0,0 +1,69 @@
+import flet as ft
+
+import flet_audio_recorder as far
+
+
+def main(page: ft.Page):
+    page.horizontal_alignment = ft.CrossAxisAlignment.CENTER
+    page.appbar = ft.AppBar(title=ft.Text("Audio Recorder"), center_title=True)
+
+    path = "test-audio-file.wav"
+
+    def show_snackbar(message):
+        page.show_dialog(ft.SnackBar(ft.Text(message)))
+
+    async def handle_recording_start(e: ft.Event[ft.Button]):
+        show_snackbar("Starting recording...")
+        await recorder.start_recording(output_path=path)
+
+    async def handle_recording_stop(e: ft.Event[ft.Button]):
+        output_path = await recorder.stop_recording()
+        show_snackbar(f"Stopped recording. Output Path: {output_path}")
+        if page.web and output_path is not None:
+            await page.launch_url(output_path)
+
+    async def handle_list_devices(e: ft.Event[ft.Button]):
+        o = await recorder.get_input_devices()
+        show_snackbar(f"Input Devices: {', '.join([d.label for d in o])}")
+
+    async def handle_has_permission(e: ft.Event[ft.Button]):
+        try:
+            status = await recorder.has_permission()
+            show_snackbar(f"Audio Recording Permission status: {status}")
+        except Exception as e:
+            show_snackbar(f"Error checking permission: {e}")
+
+    async def handle_pause(e: ft.Event[ft.Button]):
+        print(f"isRecording: {await recorder.is_recording()}")
+        if await recorder.is_recording():
+            await recorder.pause_recording()
+
+    async def handle_resume(e: ft.Event[ft.Button]):
+        print(f"isPaused: {await recorder.is_paused()}")
+        if await recorder.is_paused():
+            await recorder.resume_recording()
+
+    async def handle_audio_encoder_test(e: ft.Event[ft.Button]):
+        print(await recorder.is_supported_encoder(far.AudioEncoder.WAV))
+
+    recorder = far.AudioRecorder(
+        configuration=far.AudioRecorderConfiguration(encoder=far.AudioEncoder.WAV),
+        on_state_change=lambda e: print(f"State Changed: {e.data}"),
+    )
+    page.services.append(recorder)
+
+    page.add(
+        ft.Button(content="Start Audio Recorder", on_click=handle_recording_start),
+        ft.Button(content="Stop Audio Recorder", on_click=handle_recording_stop),
+        ft.Button(content="List Devices", on_click=handle_list_devices),
+        ft.Button(content="Pause Recording", on_click=handle_pause),
+        ft.Button(content="Resume Recording", on_click=handle_resume),
+        ft.Button(content="WAV Encoder Support", on_click=handle_audio_encoder_test),
+        ft.Button(
+            content="Get Audio Recording Permission Status",
+            on_click=handle_has_permission,
+        ),
+    )
+
+
+ft.run(main)