Merge pull request #3 from flet-dev/v1

flet-audio-recorder v1

Author: ndonkoHenri

.github/workflows/docs.yml

@@ -0,0 +1,58 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'LICENSE'
+      - 'CHANGELOG.md'
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'pyproject.toml'
+      - '.github/workflows/docs.yml'
+      - 'src/flet_audio_recorder/**'
+      - 'examples/audio_recorder_example/src/**'
+
+  workflow_dispatch:    # Allow manual trigger from the GitHub Actions UI
+
+concurrency:
+  group: "docs"                   # Prevent multiple overlapping deploys
+  cancel-in-progress: false       # Allow in-progress deploys to finish
+
+permissions:
+  contents: write  # Required to push to the gh-pages branch
+
+env:
+  GH_TOKEN: ${{ secrets.GH_TOKEN }}         # Token used by mkdocs for pushing
+  UV_SYSTEM_PYTHON: 1                       # Use system Python interpreter with uv
+
+jobs:
+  deploy:
+    name: Deploy Documentation
+    runs-on: ubuntu-latest
+    if: github.repository == github.event.repository.full_name  # don't run on forks
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Configure Git for mkdocs
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"  # Match Python version with project config
+
+      - name: Install dependencies
+        run: |
+          uv pip install -e .
+          uv pip install --group docs
+
+      - name: Deploy to GitHub Pages
+        run: uv run mkdocs gh-deploy --force

.gitignore

@@ -4,3 +4,4 @@ develop-eggs/
 dist/
 .DS_store
 /site
+.venv/

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+  - repo: https://github.com/ambv/black
+    rev: 22.12.0
+    hooks:
+      - id: black

CHANGELOG.md

@@ -0,0 +1,50 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2025-06-26
+
+### Added
+
+- Deployed online documentation: https://flet-dev.github.io/flet-audiorecorder/
+- `AudioRecorder` control new property: `configuration`
+- New dataclasses:
+    - `AudioRecorderConfiguration`
+    - `AndroidRecorderConfiguration`
+    - `IosRecorderConfiguration`
+    - `InputDevice`
+- New enums:
+    - `AndroidAudioSource`
+    - `IosAudioCategoryOption`
+
+### Changed
+
+- Refactored `AudioRecorder` control to use `@ft.control` dataclass-style definition and switched to `Service` control type
+
+#### Breaking Changes
+
+- `AudioRecorder` must now be added to `Page.services` instead of `Page.overlay`.
+- 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`
+
+## [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

README.md

@@ -1,23 +1,53 @@
-# AudioRecorder
+# flet-audio-recorder
 
-Audio recorder from microphone to a given file path. Works on macOS, Linux, Windows, iOS, Android and web.
-Based on the [record](https://pub.dev/packages/record) Dart/Flutter package.
+[![pypi](https://img.shields.io/pypi/v/flet-audio-recorder.svg)](https://pypi.python.org/pypi/flet-audio-recorder)
+[![downloads](https://static.pepy.tech/badge/flet-audio-recorder/month)](https://pepy.tech/project/flet-audio-recorder)
+[![license](https://img.shields.io/github/license/flet-dev/flet-audio-recorder.svg)](https://github.com/flet-dev/flet-audio-recorder/blob/main/LICENSE)
 
-**NOTE:** On Linux, encoding is provided by [fmedia](https://stsaz.github.io/fmedia/) which must be installed separately.
+Adds audio recording support to [Flet](https://flet.dev) apps.
 
-AudioRecorder control is non-visual and should be added to `page.overlay` list.
+It is based on the [record](https://pub.dev/packages/record) Flutter package.
+
+## Documentation
+
+Detailed documentation to this package can be found [here](https://flet-dev.github.io/flet-audio-recorder/).
+
+## Platform Support
+
+This package supports the following platforms:
+
+| Platform | Supported |
+|----------|:---------:|
+| Windows  |     ✅     |
+| macOS    |     ✅     |
+| Linux    |     ✅     |
+| iOS      |     ✅     |
+| Android  |     ✅     |
+| Web      |     ✅     |
 
 ## Installation
 
-Add `flet-audio-recorder` as dependency to `pyproject.toml` of your Flet app:
+To install the `flet-audio-recorder` package and add it to your project dependencies:
 
-```
-dependencies = [
-  "flet-audio-recorder",
-  "flet>=0.27.4",
-]
-```
+- Using `uv`:
+    ```bash
+    uv add flet-audio-recorder
+    ```
 
-## Documentation
+- Using `pip`:
+    ```bash
+    pip install flet-audio-recorder
+    ```
+    After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
+
+- Using `poetry`:
+    ```bash
+    poetry add flet-audio-recorder
+    ```
+
+> [!NOTE]
+> On Linux, encoding is provided by [fmedia](https://stsaz.github.io/fmedia/) which must be installed separately.
+
+## Examples
 
-https://flet-dev.github.io/flet-audio-recorder/
+For examples, see [this](./examples)

docs/audio_recorder.md

@@ -0,0 +1 @@
+::: flet_audio_recorder.audio_recorder.AudioRecorder