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

* 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_map
+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'

README.md

@@ -25,7 +25,9 @@ This package supports the following platforms:
 | Android  |     ✅     |
 | Web      |     ✅     |
 
-## Installation
+## Usage
+
+### Installation
 
 To install the `flet-map` package and add it to your project dependencies:
 
@@ -45,6 +47,6 @@ To install the `flet-map` package and add it to your project dependencies:
     poetry add flet-map
     ```
 
-## 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/index.md

@@ -44,9 +44,6 @@ To install the `flet-map` package and add it to your project dependencies:
     poetry add flet-map
     ```
 
+### Examples
 
-## Example
-
-```python title="main.py"
---8<-- "examples/map_example/src/main.py"
-```
+See [these](map.md#examples).

docs/map.md

@@ -1 +1,9 @@
-::: flet_map.map.Map
+## Examples
+
+### Example 1
+
+```python title="example_1.py"
+--8<-- "examples/map_example/src/example_1.py"
+```
+
+::: flet_map.map.Map

examples/map_example/src/main.py examples/map_example/src/example_1.pyexamples/map_example/src/main.py renamed to examples/map_example/src/example_1.py

@@ -65,7 +65,7 @@ def handle_tap(e: ftm.MapTapEvent):
                 ),
                 ftm.SimpleAttribution(
                     text="Flet",
-                    alignment=ft.Alignment.top_right(),
+                    alignment=ft.Alignment.TOP_RIGHT,
                     on_click=lambda e: print("Clicked SimpleAttribution"),
                 ),
                 ftm.MarkerLayer(

mkdocs.yml

@@ -149,6 +149,11 @@ plugins:
       alias_type: symlink
   - glightbox
   - section-index
+  - external-images:
+      mappings:
+        - source_dir: examples
+          target_url_path: examples
+          include_exts: [ ".png", ".gif", ".svg" ]
   - mkdocstrings:
       default_handler: python_xref
       handlers:
@@ -174,7 +179,6 @@ plugins:
             preload_modules: [ flet ]
             filters:
               - "!^_"   # Exclude private members starting with only one underscore
-              - "!get_event_field_type"
             extensions:
               - griffe_modernized_annotations
               - griffe_warnings_deprecated
@@ -225,3 +229,4 @@ markdown_extensions:
   - pymdownx.tasklist:
       custom_checkbox: true
   - pymdownx.tilde
+  - pymdownx.blocks.caption