Merge pull request #3 from flet-dev/v1

flet-flashlight v1

Author: FeodorFitsner

.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_flashlight/**'
+      - 'examples/flashlight_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

@@ -2,4 +2,5 @@
 build/
 develop-eggs/
 dist/
-.DS_store
+.DS_store
+.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,35 @@
+# 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-flashlight/
+- `Flashlight` control new properties: `on`, `on_error`
+- `Flashlight` control new methods: `is_available_async`
+- New exception classes:
+    - `FlashlightException`
+    - `FlashlightEnableExistentUserException`
+    - `FlashlightEnableNotAvailableException`
+    - `FlashlightEnableException`
+    - `FlashlightDisableExistentUserException`
+    - `FlashlightDisableNotAvailableException`
+    - `FlashlightDisableException`
+
+### Changed
+
+- Refactored `Flashlight` control to use `@ft.control` dataclass-style definition and switched to `Service` control type.
+- `Flashlight` must now be added to `Page.services` instead of `Page.overlay` due to control type change.
+
+## [0.1.0] - 2025-01-15
+
+Initial release.
+
+
+[0.2.0]: https://github.com/flet-dev/flet-flashlight/compare/0.1.0...0.2.0
+[0.1.0]: https://github.com/flet-dev/flet-flashlight/releases/tag/0.1.0

README.md

@@ -1,25 +1,46 @@
-# Flashlight control for Flet
+# flet-flashlight
 
-`Flashlight` control for Flet.
+[![pypi](https://img.shields.io/pypi/v/flet-flashlight.svg)](https://pypi.python.org/pypi/flet-flashlight)
+[![downloads](https://static.pepy.tech/badge/flet-flashlight/month)](https://pepy.tech/project/flet-flashlight)
+[![license](https://img.shields.io/github/license/flet-dev/flet-flashlight.svg)](https://github.com/flet-dev/flet-flashlight/blob/main/LICENSE)
 
-## Usage
+A [Flet](https://flet.dev) extension to manage the device torch/flashlight.
 
-Add `flet-flashlight` as dependency (`pyproject.toml` or `requirements.txt`) to your Flet project.
+It is based on the [flashlight](https://pub.dev/packages/flashlight) Flutter package.
 
-## Example
+## Documentation
 
-```py
+Detailed documentation to this package can be found [here](https://flet-dev.github.io/flet-flashlight/).
 
-import flet as ft
+## Platform Support
 
-import flet_flashlight as ffl
+This package supports the following platforms:
 
-def main(page: ft.Page):
-    flashlight = ffl.Flashlight()
-    page.overlay.append(flashlight)
-    page.add(
-        ft.TextButton("toggle", on_click=lambda _: flashlight.toggle())
-    )
+| Platform | Supported |
+|----------|:---------:|
+| Windows  |     ❌     |
+| macOS    |     ❌     |
+| Linux    |     ❌     |
+| iOS      |     ✅     |
+| Android  |     ✅     |
+| Web      |     ❌     |
 
-ft.app(main)
-```
+## Installation
+
+To install the `flet-flashlight` package and add it to your project dependencies:
+
+- Using `uv`:
+    ```bash
+    uv add flet-flashlight
+    ```
+
+- Using `pip`:
+    ```bash
+    pip install flet-flashlight
+    ```
+    After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
+
+- Using `poetry`:
+    ```bash
+    poetry add flet-flashlight
+    ```

docs/changelog.md

@@ -0,0 +1,5 @@
+---
+title: Changelog
+---
+
+--8<-- "CHANGELOG.md"

docs/exceptions/flashlight_disable_exception.md

@@ -0,0 +1 @@
+::: flet_flashlight.exceptions.FlashlightDisableException

docs/exceptions/flashlight_disable_existent_user_exception.md

@@ -0,0 +1 @@
+::: flet_flashlight.exceptions.FlashlightDisableExistentUserException

docs/exceptions/flashlight_disable_not_available_exception.md

@@ -0,0 +1 @@
+::: flet_flashlight.exceptions.FlashlightDisableNotAvailableException

docs/exceptions/flashlight_enable_exception.md

@@ -0,0 +1 @@
+::: flet_flashlight.exceptions.FlashlightEnableException