flet-ads 0.1.0.dev2__tar.gz

flet_ads-0.1.0.dev2/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.2
+Name: flet-ads
+Version: 0.1.0.dev2
+Summary: Ads controls for Flet
+Author-email: Flet contributors <hello@flet.dev>
+Project-URL: Homepage, https://flet.dev
+Project-URL: Documentation, https://flet.dev/docs/controls/ads
+Project-URL: Repository, https://github.com/flet-dev/flet-ads
+Project-URL: Issues, https://github.com/flet-dev/flet-ads/issues
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: flet>=0.25.2
+
+# Ads controls for Flet
+
+`BannerAd` and `InterstitialAd` controls for Flet.
+
+## Usage
+
+Add `flet-ads` as dependency (`pyproject.toml` or `requirements.txt`) to your Flet project.
+
+## Example
+
+```py
+
+import flet as ft
+
+import flet_ads as ads
+
+
+def main(page: ft.Page):
+    page.horizontal_alignment = ft.CrossAxisAlignment.CENTER
+
+    id_interstitial = (
+        "ca-app-pub-3940256099942544/1033173712"
+        if page.platform == ft.PagePlatform.ANDROID
+        else "ca-app-pub-3940256099942544/4411468910"
+    )
+
+    id_banner = (
+        "ca-app-pub-3940256099942544/6300978111"
+        if page.platform == ft.PagePlatform.ANDROID
+        else "ca-app-pub-3940256099942544/2934735716"
+    )
+
+    def handle_interstitial_close(e):
+        nonlocal iad
+        print("InterstitialAd closed")
+        page.overlay.remove(e.control)
+        page.overlay.append(iad := get_new_interstitial_ad())
+        page.update()
+
+    def get_new_interstitial_ad():
+        return ads.InterstitialAd(
+            unit_id=id_interstitial,
+            on_load=lambda e: print("InterstitialAd loaded"),
+            on_error=lambda e: print("InterstitialAd error", e.data),
+            on_open=lambda e: print("InterstitialAd opened"),
+            on_close=handle_interstitial_close,
+            on_impression=lambda e: print("InterstitialAd impression"),
+            on_click=lambda e: print("InterstitialAd clicked"),
+        )
+
+    def display_new_banner_ad():
+        page.add(
+            ft.Container(
+                content=ads.BannerAd(
+                    unit_id=id_banner,
+                    on_click=lambda e: print("BannerAd clicked"),
+                    on_load=lambda e: print("BannerAd loaded"),
+                    on_error=lambda e: print("BannerAd error", e.data),
+                    on_open=lambda e: print("BannerAd opened"),
+                    on_close=lambda e: print("BannerAd closed"),
+                    on_impression=lambda e: print("BannerAd impression"),
+                    on_will_dismiss=lambda e: print("BannerAd will dismiss"),
+                ),
+                width=320,
+                height=50,
+                bgcolor=ft.colors.TRANSPARENT,
+            )
+        )
+
+    page.overlay.append(iad := get_new_interstitial_ad())
+    page.appbar = ft.AppBar(
+        adaptive=True,
+        title=ft.Text("Mobile Ads Playground"),
+        bgcolor=ft.colors.LIGHT_BLUE_300,
+    )
+    page.add(
+        ft.OutlinedButton("Show InterstitialAd", on_click=lambda e: iad.show()),
+        ft.OutlinedButton("Show BannerAd", on_click=lambda e: display_new_banner_ad()),
+    )
+
+
+ft.app(main)
+```

flet_ads-0.1.0.dev2/README.md

@@ -0,0 +1,83 @@
+# Ads controls for Flet
+
+`BannerAd` and `InterstitialAd` controls for Flet.
+
+## Usage
+
+Add `flet-ads` as dependency (`pyproject.toml` or `requirements.txt`) to your Flet project.
+
+## Example
+
+```py
+
+import flet as ft
+
+import flet_ads as ads
+
+
+def main(page: ft.Page):
+    page.horizontal_alignment = ft.CrossAxisAlignment.CENTER
+
+    id_interstitial = (
+        "ca-app-pub-3940256099942544/1033173712"
+        if page.platform == ft.PagePlatform.ANDROID
+        else "ca-app-pub-3940256099942544/4411468910"
+    )
+
+    id_banner = (
+        "ca-app-pub-3940256099942544/6300978111"
+        if page.platform == ft.PagePlatform.ANDROID
+        else "ca-app-pub-3940256099942544/2934735716"
+    )
+
+    def handle_interstitial_close(e):
+        nonlocal iad
+        print("InterstitialAd closed")
+        page.overlay.remove(e.control)
+        page.overlay.append(iad := get_new_interstitial_ad())
+        page.update()
+
+    def get_new_interstitial_ad():
+        return ads.InterstitialAd(
+            unit_id=id_interstitial,
+            on_load=lambda e: print("InterstitialAd loaded"),
+            on_error=lambda e: print("InterstitialAd error", e.data),
+            on_open=lambda e: print("InterstitialAd opened"),
+            on_close=handle_interstitial_close,
+            on_impression=lambda e: print("InterstitialAd impression"),
+            on_click=lambda e: print("InterstitialAd clicked"),
+        )
+
+    def display_new_banner_ad():
+        page.add(
+            ft.Container(
+                content=ads.BannerAd(
+                    unit_id=id_banner,
+                    on_click=lambda e: print("BannerAd clicked"),
+                    on_load=lambda e: print("BannerAd loaded"),
+                    on_error=lambda e: print("BannerAd error", e.data),
+                    on_open=lambda e: print("BannerAd opened"),
+                    on_close=lambda e: print("BannerAd closed"),
+                    on_impression=lambda e: print("BannerAd impression"),
+                    on_will_dismiss=lambda e: print("BannerAd will dismiss"),
+                ),
+                width=320,
+                height=50,
+                bgcolor=ft.colors.TRANSPARENT,
+            )
+        )
+
+    page.overlay.append(iad := get_new_interstitial_ad())
+    page.appbar = ft.AppBar(
+        adaptive=True,
+        title=ft.Text("Mobile Ads Playground"),
+        bgcolor=ft.colors.LIGHT_BLUE_300,
+    )
+    page.add(
+        ft.OutlinedButton("Show InterstitialAd", on_click=lambda e: iad.show()),
+        ft.OutlinedButton("Show BannerAd", on_click=lambda e: display_new_banner_ad()),
+    )
+
+
+ft.app(main)
+```

flet_ads-0.1.0.dev2/pyproject.toml

@@ -0,0 +1,36 @@
+[project]
+name = "flet-ads"
+version = "0.1.0.dev2"
+description = "Ads controls for Flet"
+readme = "README.md"
+authors = [
+    { name = "Flet contributors", email = "hello@flet.dev" }
+]
+classifiers = [
+  "License :: OSI Approved :: Apache Software License",
+]
+requires-python = ">=3.8"
+dependencies = [
+    "flet>=0.25.2",
+]
+
+[project.urls]
+Homepage = "https://flet.dev"
+Documentation = "https://flet.dev/docs/controls/ads"
+Repository = "https://github.com/flet-dev/flet-ads"
+Issues = "https://github.com/flet-dev/flet-ads/issues"
+
+[tool.setuptools.package-data]
+"flutter.flet_ads" = ["**/*"]
+
+[tool.uv]
+dev-dependencies = [
+    "flet[all]>=0.25.2",
+]
+
+[tool.setuptools]
+license-files = []
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"

flet_ads-0.1.0.dev2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

flet_ads-0.1.0.dev2/src/flet_ads/__init__.py

@@ -0,0 +1,10 @@
+from flet_ads.banner import BannerAd
+from flet_ads.interstitial import InterstitialAd
+
+# from flet_ads.native import (
+#     NativeAd,
+#     NativeAdTemplateStyle,
+#     NativeAdTemplateTextStyle,
+#     NativeAdTemplateType,
+#     NativeTemplateFontStyle,
+# )

flet_ads-0.1.0.dev2/src/flet_ads/banner.py

@@ -0,0 +1,110 @@
+from typing import Any, Optional, Union
+
+from flet.core.animation import AnimationValue
+from flet.core.control import OptionalNumber
+from flet.core.ref import Ref
+from flet.core.types import (
+    OffsetValue,
+    OptionalControlEventCallable,
+    ResponsiveNumber,
+    RotateValue,
+    ScaleValue,
+)
+
+from flet_ads.base_ad import BaseAd
+
+
+class BannerAd(BaseAd):
+    """
+    Displays a banner ad.
+
+    -----
+
+    Online docs: https://flet.dev/docs/controls/bannerad
+    """
+
+    def __init__(
+        self,
+        unit_id: str,
+        on_load: OptionalControlEventCallable = None,
+        on_error: OptionalControlEventCallable = None,
+        on_open: OptionalControlEventCallable = None,
+        on_close: OptionalControlEventCallable = None,
+        on_impression: OptionalControlEventCallable = None,
+        on_click: OptionalControlEventCallable = None,
+        on_will_dismiss: OptionalControlEventCallable = None,
+        #
+        # ConstrainedControl
+        #
+        ref: Optional[Ref] = None,
+        key: Optional[str] = None,
+        width: OptionalNumber = None,
+        height: OptionalNumber = None,
+        left: OptionalNumber = None,
+        top: OptionalNumber = None,
+        right: OptionalNumber = None,
+        bottom: OptionalNumber = None,
+        expand: Union[None, bool, int] = None,
+        expand_loose: Optional[bool] = None,
+        col: Optional[ResponsiveNumber] = None,
+        opacity: OptionalNumber = None,
+        rotate: RotateValue = None,
+        scale: ScaleValue = None,
+        offset: OffsetValue = None,
+        aspect_ratio: OptionalNumber = None,
+        animate_opacity: AnimationValue = None,
+        animate_size: AnimationValue = None,
+        animate_position: AnimationValue = None,
+        animate_rotation: AnimationValue = None,
+        animate_scale: AnimationValue = None,
+        animate_offset: AnimationValue = None,
+        on_animation_end: OptionalControlEventCallable = None,
+        tooltip: Optional[str] = None,
+        visible: Optional[bool] = None,
+        disabled: Optional[bool] = None,
+        data: Any = None,
+    ):
+        BaseAd.__init__(
+            self,
+            unit_id=unit_id,
+            on_load=on_load,
+            on_error=on_error,
+            on_open=on_open,
+            on_close=on_close,
+            on_impression=on_impression,
+            on_click=on_click,
+            on_will_dismiss=on_will_dismiss,
+            #
+            # ConstrainedControl
+            #
+            ref=ref,
+            key=key,
+            width=width,
+            height=height,
+            left=left,
+            top=top,
+            right=right,
+            bottom=bottom,
+            expand=expand,
+            expand_loose=expand_loose,
+            col=col,
+            opacity=opacity,
+            rotate=rotate,
+            scale=scale,
+            offset=offset,
+            aspect_ratio=aspect_ratio,
+            animate_opacity=animate_opacity,
+            animate_size=animate_size,
+            animate_position=animate_position,
+            animate_rotation=animate_rotation,
+            animate_scale=animate_scale,
+            animate_offset=animate_offset,
+            on_animation_end=on_animation_end,
+            tooltip=tooltip,
+            visible=visible,
+            disabled=disabled,
+            data=data,
+        )
+
+    def _get_control_name(self):
+        return "banner_ad"

flet_ads-0.1.0.dev2/src/flet_ads/base_ad.py

@@ -0,0 +1,174 @@
+from typing import Any, Optional, Union
+
+from flet.core.animation import AnimationValue
+from flet.core.constrained_control import ConstrainedControl
+from flet.core.control import OptionalNumber
+from flet.core.ref import Ref
+from flet.core.types import (
+    OffsetValue,
+    OptionalControlEventCallable,
+    PagePlatform,
+    ResponsiveNumber,
+    RotateValue,
+    ScaleValue,
+)
+
+
+class BaseAd(ConstrainedControl):
+    def __init__(
+        self,
+        unit_id: str,
+        on_load: OptionalControlEventCallable = None,
+        on_error: OptionalControlEventCallable = None,
+        on_open: OptionalControlEventCallable = None,
+        on_close: OptionalControlEventCallable = None,
+        on_impression: OptionalControlEventCallable = None,
+        on_click: OptionalControlEventCallable = None,
+        on_will_dismiss: OptionalControlEventCallable = None,
+        #
+        # ConstrainedControl
+        #
+        ref: Optional[Ref] = None,
+        key: Optional[str] = None,
+        width: OptionalNumber = None,
+        height: OptionalNumber = None,
+        left: OptionalNumber = None,
+        top: OptionalNumber = None,
+        right: OptionalNumber = None,
+        bottom: OptionalNumber = None,
+        expand: Union[None, bool, int] = None,
+        expand_loose: Optional[bool] = None,
+        col: Optional[ResponsiveNumber] = None,
+        opacity: OptionalNumber = None,
+        rotate: RotateValue = None,
+        scale: ScaleValue = None,
+        offset: OffsetValue = None,
+        aspect_ratio: OptionalNumber = None,
+        animate_opacity: AnimationValue = None,
+        animate_size: AnimationValue = None,
+        animate_position: AnimationValue = None,
+        animate_rotation: AnimationValue = None,
+        animate_scale: AnimationValue = None,
+        animate_offset: AnimationValue = None,
+        on_animation_end: OptionalControlEventCallable = None,
+        tooltip: Optional[str] = None,
+        visible: Optional[bool] = None,
+        disabled: Optional[bool] = None,
+        data: Any = None,
+    ):
+        ConstrainedControl.__init__(
+            self,
+            ref=ref,
+            key=key,
+            width=width,
+            height=height,
+            left=left,
+            top=top,
+            right=right,
+            bottom=bottom,
+            expand=expand,
+            expand_loose=expand_loose,
+            col=col,
+            opacity=opacity,
+            rotate=rotate,
+            scale=scale,
+            offset=offset,
+            aspect_ratio=aspect_ratio,
+            animate_opacity=animate_opacity,
+            animate_size=animate_size,
+            animate_position=animate_position,
+            animate_rotation=animate_rotation,
+            animate_scale=animate_scale,
+            animate_offset=animate_offset,
+            on_animation_end=on_animation_end,
+            tooltip=tooltip,
+            visible=visible,
+            disabled=disabled,
+            data=data,
+        )
+
+        self.on_load = on_load
+        self.on_error = on_error
+        self.on_open = on_open
+        self.on_close = on_close
+        self.on_impression = on_impression
+        self.on_click = on_click
+        self.on_will_dismiss = on_will_dismiss
+        self.unit_id = unit_id
+
+    def before_update(self):
+        assert self.page.platform in [
+            PagePlatform.ANDROID,
+            PagePlatform.IOS,
+        ], f"{self.__class__.__name__} is only supported on Mobile (Android and iOS). "
+
+    @property
+    def unit_id(self) -> str:
+        return self._get_attr("unitId")
+
+    @unit_id.setter
+    def unit_id(self, value: str):
+        self._set_attr("unitId", value)
+
+    # on_load
+    @property
+    def on_load(self):
+        return self._get_event_handler("load")
+
+    @on_load.setter
+    def on_load(self, handler):
+        self._add_event_handler("load", handler)
+
+    # on_error
+    @property
+    def on_error(self):
+        return self._get_event_handler("error")
+
+    @on_error.setter
+    def on_error(self, handler):
+        self._add_event_handler("error", handler)
+
+    # on_open
+    @property
+    def on_open(self):
+        return self._get_event_handler("open")
+
+    @on_open.setter
+    def on_open(self, handler):
+        self._add_event_handler("open", handler)
+
+    # on_close
+    @property
+    def on_close(self):
+        return self._get_event_handler("close")
+
+    @on_close.setter
+    def on_close(self, handler):
+        self._add_event_handler("close", handler)
+
+    # on_click
+    @property
+    def on_click(self):
+        return self._get_event_handler("click")
+
+    @on_click.setter
+    def on_click(self, handler):
+        self._add_event_handler("click", handler)
+
+    # on_impression
+    @property
+    def on_impression(self):
+        return self._get_event_handler("impression")
+
+    @on_impression.setter
+    def on_impression(self, handler):
+        self._add_event_handler("impression", handler)
+
+    # on_will_dismiss
+    @property
+    def on_will_dismiss(self):
+        return self._get_event_handler("willDismiss")
+
+    @on_will_dismiss.setter
+    def on_will_dismiss(self, handler):
+        self._add_event_handler("willDismiss", handler)

flet_ads-0.1.0.dev2/src/flet_ads/interstitial.py

@@ -0,0 +1,111 @@
+from typing import Any, Optional, Union
+
+from flet.core.animation import AnimationValue
+from flet.core.control import OptionalNumber
+from flet.core.ref import Ref
+from flet.core.types import (
+    OffsetValue,
+    OptionalControlEventCallable,
+    ResponsiveNumber,
+    RotateValue,
+    ScaleValue,
+)
+
+from flet_ads.base_ad import BaseAd
+
+
+class InterstitialAd(BaseAd):
+    """
+    Displays a full screen interstitial ad.
+
+    -----
+
+    Online docs: https://flet.dev/docs/controls/interstitialad
+    """
+
+    def __init__(
+        self,
+        unit_id: str,
+        on_load: OptionalControlEventCallable = None,
+        on_error: OptionalControlEventCallable = None,
+        on_open: OptionalControlEventCallable = None,
+        on_close: OptionalControlEventCallable = None,
+        on_impression: OptionalControlEventCallable = None,
+        on_click: OptionalControlEventCallable = None,
+        #
+        # ConstrainedControl
+        #
+        ref: Optional[Ref] = None,
+        key: Optional[str] = None,
+        width: OptionalNumber = None,
+        height: OptionalNumber = None,
+        left: OptionalNumber = None,
+        top: OptionalNumber = None,
+        right: OptionalNumber = None,
+        bottom: OptionalNumber = None,
+        expand: Union[None, bool, int] = None,
+        expand_loose: Optional[bool] = None,
+        col: Optional[ResponsiveNumber] = None,
+        opacity: OptionalNumber = None,
+        rotate: RotateValue = None,
+        scale: ScaleValue = None,
+        offset: OffsetValue = None,
+        aspect_ratio: OptionalNumber = None,
+        animate_opacity: AnimationValue = None,
+        animate_size: AnimationValue = None,
+        animate_position: AnimationValue = None,
+        animate_rotation: AnimationValue = None,
+        animate_scale: AnimationValue = None,
+        animate_offset: AnimationValue = None,
+        on_animation_end: OptionalControlEventCallable = None,
+        tooltip: Optional[str] = None,
+        visible: Optional[bool] = None,
+        disabled: Optional[bool] = None,
+        data: Any = None,
+    ):
+        BaseAd.__init__(
+            self,
+            unit_id=unit_id,
+            on_load=on_load,
+            on_error=on_error,
+            on_open=on_open,
+            on_close=on_close,
+            on_impression=on_impression,
+            on_click=on_click,
+            #
+            # ConstrainedControl
+            #
+            ref=ref,
+            key=key,
+            width=width,
+            height=height,
+            left=left,
+            top=top,
+            right=right,
+            bottom=bottom,
+            expand=expand,
+            expand_loose=expand_loose,
+            col=col,
+            opacity=opacity,
+            rotate=rotate,
+            scale=scale,
+            offset=offset,
+            aspect_ratio=aspect_ratio,
+            animate_opacity=animate_opacity,
+            animate_size=animate_size,
+            animate_position=animate_position,
+            animate_rotation=animate_rotation,
+            animate_scale=animate_scale,
+            animate_offset=animate_offset,
+            on_animation_end=on_animation_end,
+            tooltip=tooltip,
+            visible=visible,
+            disabled=disabled,
+            data=data,
+        )
+
+    def _get_control_name(self):
+        return "interstitial_ad"
+
+    def show(self):
+        self.invoke_method("show")