flet-ads 0.0.1__py3-none-any.whl → 0.1.0__py3-none-any.whl

flet_ads/__init__.py

@@ -1 +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/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/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/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")

flet_ads/native.py

@@ -0,0 +1,171 @@
+import dataclasses
+from enum import Enum
+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, ResponsiveNumber, RotateValue, ScaleValue
+
+from flet_ads.base_ad import BaseAd
+
+
+class NativeAdTemplateType(Enum):
+    SMALL = "small"
+    MEDIUM = "medium"
+
+
+class NativeTemplateFontStyle(Enum):
+    NORMAL = "normal"
+    BOLD = "bold"
+    ITALIC = "italic"
+    MONOSPACE = "monospace"
+
+
+@dataclasses.dataclass
+class NativeAdTemplateTextStyle:
+    size: OptionalNumber = dataclasses.field(default=None)
+    text_color: Optional[str] = dataclasses.field(default=None)
+    bgcolor: Optional[str] = dataclasses.field(default=None)
+    style: Optional[NativeTemplateFontStyle] = dataclasses.field(default=None)
+
+
+@dataclasses.dataclass
+class NativeAdTemplateStyle:
+    template_type: Optional[NativeAdTemplateType] = dataclasses.field(default=None)
+    main_bgcolor: Optional[str] = dataclasses.field(default=None)
+    corner_radius: OptionalNumber = dataclasses.field(default=None)
+    call_to_action_text_style: Optional[NativeAdTemplateTextStyle] = dataclasses.field(
+        default=None
+    )
+    primary_text_style: Optional[NativeAdTemplateTextStyle] = dataclasses.field(
+        default=None
+    )
+    secondary_text_style: Optional[NativeAdTemplateTextStyle] = dataclasses.field(
+        default=None
+    )
+    tertiary_text_style: Optional[NativeAdTemplateTextStyle] = dataclasses.field(
+        default=None
+    )
+
+
+class NativeAd(BaseAd):
+    """
+    TBA
+
+    -----
+
+    Online docs: https://flet.dev/docs/controls/nativead
+    """
+
+    def __init__(
+        self,
+        unit_id: str = None,
+        factory_id: str = None,
+        template_style: NativeAdTemplateStyle = None,
+        on_load=None,
+        on_error=None,
+        on_open=None,
+        on_close=None,
+        on_impression=None,
+        on_click=None,
+        on_will_dismiss=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=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,
+        )
+
+        self.template_style = template_style
+        self.factory_id = factory_id
+
+    def _get_control_name(self):
+        return "native_ad"
+
+    def before_update(self):
+        super().before_update()
+        self._set_attr_json("templateStyle", self.__template_style)
+
+    @property
+    def template_style(self):
+        return self.__template_style
+
+    @template_style.setter
+    def template_style(self, value):
+        self.__template_style = value
+
+    # factory_id
+    @property
+    def factory_id(self) -> Optional[str]:
+        return self._get_attr("factoryId")
+
+    @factory_id.setter
+    def factory_id(self, value: Optional[str]):
+        self._set_attr("factoryId", value)

flet_ads-0.1.0.dist-info/METADATA

@@ -0,0 +1,97 @@
+Metadata-Version: 2.2
+Name: flet-ads
+Version: 0.1.0
+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.dist-info/RECORD

@@ -0,0 +1,21 @@
+flet_ads/__init__.py,sha256=YmJRcMtuH33BZTprwZNCWz1kTXzPs7Ro7AusRt3kaUM,260
+flet_ads/banner.py,sha256=0Z1WthSu5ikQw72-netom6TK8KNNO9MzGSWZdeyddkY,3388
+flet_ads/base_ad.py,sha256=4jvDFwdeiSZUSfNq-7NpI8FuaAAL9t-H4YhMyKIiSmI,5144
+flet_ads/interstitial.py,sha256=1r8Y0BIF641e2jMqRU19Xv0d_X4I3H99pvtOb2VUUWQ,3373
+flet_ads/native.py,sha256=mx4haIzoEs_1cQe9HGtci4qgVx-mOg_YISd00hmWd40,5066
+flutter/flet_ads/CHANGELOG.md,sha256=66sWepPaeTc9_lzcYIGU55AlxSU5Z1XVtknXpzd_-p8,40
+flutter/flet_ads/LICENSE,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
+flutter/flet_ads/README.md,sha256=PyyWlFSXK26RDkXzhow7KXNwhbnWXxnIvJNtqOcTYIE,110
+flutter/flet_ads/analysis_options.yaml,sha256=32kjGAc-zF87inWaH5M46yGZWQDTwrwfvNLHeAocfG4,154
+flutter/flet_ads/pubspec.lock,sha256=PC5lkP4lgUNzey5sINtW8rJCtv9M5kg4VQJqiroXCHs,22557
+flutter/flet_ads/pubspec.yaml,sha256=TxD47c-N36ND1RDwmSzqoYTWEYisN25vdKPubqg3fXA,399
+flutter/flet_ads/lib/flet_ads.dart,sha256=HDyBvKWjtM00srxdFl-O9uXAkgNID9tKtByEL7_dhVg,91
+flutter/flet_ads/lib/src/banner.dart,sha256=6ODCVYoQCFd_wnjRBFb25ujWCgTG5YiONlVkbRZKtLM,3282
+flutter/flet_ads/lib/src/create_control.dart,sha256=4S-OKSYA4wFxF8CxIWGjW43Hm_9z-lC-RRpNHl6b_2g,888
+flutter/flet_ads/lib/src/interstitial.dart,sha256=g46c6RkFEzUVoiUtaw1g4wNEnfXXFFnEEy6Xuz8Ap-4,3044
+flutter/flet_ads/lib/src/native.dart,sha256=gA3-wvqahV929JKEmxys4jXtNBUUTlo_3nDJUWvOryU,5609
+flutter/flet_ads/lib/utils/native.dart,sha256=jiG1bT3shp3bix7gXL6GooUjTsvi7A1aZNn4ipQu76g,2425
+flet_ads-0.1.0.dist-info/METADATA,sha256=AkkbeQvBzLF6Ajmd-HBAJUo2D_HVSG1ZlVzGXlNACpY,3127
+flet_ads-0.1.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+flet_ads-0.1.0.dist-info/top_level.txt,sha256=Pguk7IG_usM8ZGyS1kjv-mZZhGKthm_734FmTIqDLBE,17
+flet_ads-0.1.0.dist-info/RECORD,,

{flet_ads-0.0.1.dist-info → flet_ads-0.1.0.dist-info}/WHEEL

@@ -1,4 +1,5 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.0
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
+