docs update

Author: ndonkoHenri

docs/index.md

@@ -21,6 +21,32 @@ This package supports the following platforms:
 | Android  |     ✅     |
 | Web      |     ❌     |
 
+## Usage
+
+### Installation
+
+To install the `flet-flashlight` package and add it to your project dependencies:
+
+=== "uv"
+
+```bash
+uv add flet-flashlight
+```
+
+=== "pip"
+
+```bash
+pip install flet-flashlight
+```
+
+    You will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
+
+=== "poetry"
+
+```bash
+poetry add flet-flashlight
+```
+
 ## Example
 
 ```python title="main.py"

examples/flashlight_example/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
-name = "flashlight_example"
+name = "flet-flashlight-example"
 version = "1.0.0"
-description = "Flet Flashlight Example"
+description = "flet-flashlight-example"
 readme = "README.md"
 license = "Apache-2.0"
 requires-python = ">=3.10"
@@ -14,26 +14,9 @@ dependencies = [
 # Docs: https://flet.dev/docs/publish
 [tool.flet]
 org = "com.mycompany"
-product = "Flet Flashlight Example"
+product = "flet-flashlight-example"
 company = "Flet"
 copyright = "Copyright (C) 2024 by Flet"
 
 [tool.flet.app]
 path = "src"
-
-[tool.flet.dev_packages]
-flet-flashlight = "../.." # relative path
-flet = "git+https://github.com/flet-dev/flet.git@v1#subdirectory=sdk/python/packages/flet"
-
-[tool.uv]
-dev-dependencies = [
-    "flet",
-    "flet-cli",
-    "flet-desktop",
-]
-
-[tool.uv.sources]
-flet-flashlight = { path = "../../", editable = true }
-flet = { git = "https://github.com/flet-dev/flet", subdirectory = "sdk/python/packages/flet", rev = "v1" }
-flet-cli = { git = "https://github.com/flet-dev/flet", subdirectory = "sdk/python/packages/flet-cli", rev = "v1" }
-flet-desktop = { git = "https://github.com/flet-dev/flet", subdirectory = "sdk/python/packages/flet-desktop", rev = "v1" }

examples/flashlight_example/src/main.py

@@ -2,11 +2,12 @@
 
 import flet_flashlight as ffl
 
+
 def main(page: ft.Page):
     flashlight = ffl.Flashlight()
-    page.overlay.append(flashlight)
-    page.add(
-        ft.TextButton("toggle", on_click=lambda _: flashlight.toggle())
-    )
+    page.services.append(flashlight)
+
+    page.add(ft.TextButton("toggle", on_click=lambda _: flashlight.toggle()))
+
 
-ft.app(main)
+ft.run(main)

mkdocs.yml

@@ -47,6 +47,7 @@ theme:
     - content.code.annotate
     - content.code.copy
     - content.code.select
+    - content.tabs.link
     # - navigation.tabs
     - navigation.instant
     - navigation.tracking
@@ -107,6 +108,7 @@ plugins:
   - mike:
       alias_type: symlink
   - glightbox
+  - section-index
   - mkdocstrings:
       default_handler: python_xref
       handlers:
@@ -131,7 +133,6 @@ plugins:
             preload_modules: [ flet ]
             filters:
               - "!^_"   # Exclude private members starting with only one underscore
-              - "^__"   # Include private members starting with two underscores
               - "!before_update"
           inventories:
             - url: https://docs.python.org/3/objects.inv
@@ -140,23 +141,42 @@ plugins:
 
 # Markdown Extensions
 markdown_extensions:
+  - abbr
   - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - md_in_html
   - toc:
       permalink: "#"
+
+  # Python Markdown Extensions
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.highlight:
       anchor_linenums: true
       line_spans: __span
       pygments_lang_class: true
   - pymdownx.inlinehilite
-  - pymdownx.snippets
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.smartsymbols
   - pymdownx.superfences
-  - pymdownx.details
+  - pymdownx.snippets
   - pymdownx.magiclink:
       repo_url_shorthand: true
   - pymdownx.tabbed:
       alternate_style: true
-  - attr_list
-  - md_in_html
-  - def_list
+      slugify: !!python/object/apply:pymdownx.slugs.slugify
+        kwds:
+          case: lower
   - pymdownx.tasklist:
       custom_checkbox: true
+  - pymdownx.tilde

pyproject.toml

@@ -32,6 +32,7 @@ docs = [
     "markdown>=3.6",
     "pymdown-extensions",
     "mkdocs-glightbox",
+    "mkdocs-section-index",
     "pygments>=2.16",
 ]
 
@@ -41,3 +42,35 @@ docs = [
 [build-system]
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
+
+[tool.ruff]
+line-length = 88
+target-version = "py39"
+fix = true
+show-fixes = true
+
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I"
+]
+ignore = [
+    # Pyflakes
+    "F401", # unused import
+]
+preview = true
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "auto"

src/flet_flashlight/flashlight.py

@@ -21,7 +21,7 @@ class Flashlight(ft.Service):
     Whether the flashlight is currently turned on.
     """
 
-    on_error: ft.OptionalControlEventCallable = None
+    on_error: ft.OptionalControlEventHandler["Flashlight"] = None
     """
     Fires when an error occurs.