flet-ads 0.1.0__tar.gz → 0.2.0.dev34__tar.gz

{flet_ads-0.1.0/src/flutter/flet_ads → flet_ads-0.2.0.dev34}/LICENSE

@@ -198,4 +198,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

flet_ads-0.2.0.dev34/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: flet-ads
+Version: 0.2.0.dev34
+Summary: Display Google Ads in Flet apps.
+Author-email: Flet contributors <hello@flet.dev>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://flet.dev
+Project-URL: Documentation, https://flet-dev.github.io/flet-ads
+Project-URL: Repository, https://github.com/flet-dev/flet-ads
+Project-URL: Issues, https://github.com/flet-dev/flet-ads/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flet>=0.70.0
+Dynamic: license-file
+
+# flet-ads
+
+[![pypi](https://img.shields.io/pypi/v/flet-ads.svg)](https://pypi.python.org/pypi/flet-ads)
+[![downloads](https://static.pepy.tech/badge/flet-ads/month)](https://pepy.tech/project/flet-ads)
+[![license](https://img.shields.io/github/license/flet-dev/flet-ads.svg)](https://github.com/flet-dev/flet-ads/blob/main/LICENSE)
+
+Display Google Ads in [Flet](https://flet.dev) apps.
+
+It is based on the [google_mobile_ads](https://pub.dev/packages/google_mobile_ads) Flutter package.
+
+## Documentation
+
+Detailed documentation to this package can be found [here](https://flet-dev.github.io/flet-ads/).
+
+## Platform Support
+
+This package supports the following platforms:
+
+| Platform | Supported |
+|----------|:---------:|
+| Windows  |     ❌     |
+| macOS    |     ❌     |
+| Linux    |     ❌     |
+| iOS      |     ✅     |
+| Android  |     ✅     |
+| Web      |     ❌     |
+
+## Installation
+
+To install the `flet-ads` package and add it to your project dependencies:
+
+- Using `uv`:
+    ```bash
+    uv add flet-ads
+    ```
+
+- Using `pip`:
+    ```bash
+    pip install flet-ads
+    ```
+    After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
+
+- Using `poetry`:
+    ```bash
+    poetry add flet-ads
+    ```
+
+## Examples
+
+For examples, see [this](./examples)

flet_ads-0.2.0.dev34/README.md

@@ -0,0 +1,50 @@
+# flet-ads
+
+[![pypi](https://img.shields.io/pypi/v/flet-ads.svg)](https://pypi.python.org/pypi/flet-ads)
+[![downloads](https://static.pepy.tech/badge/flet-ads/month)](https://pepy.tech/project/flet-ads)
+[![license](https://img.shields.io/github/license/flet-dev/flet-ads.svg)](https://github.com/flet-dev/flet-ads/blob/main/LICENSE)
+
+Display Google Ads in [Flet](https://flet.dev) apps.
+
+It is based on the [google_mobile_ads](https://pub.dev/packages/google_mobile_ads) Flutter package.
+
+## Documentation
+
+Detailed documentation to this package can be found [here](https://flet-dev.github.io/flet-ads/).
+
+## Platform Support
+
+This package supports the following platforms:
+
+| Platform | Supported |
+|----------|:---------:|
+| Windows  |     ❌     |
+| macOS    |     ❌     |
+| Linux    |     ❌     |
+| iOS      |     ✅     |
+| Android  |     ✅     |
+| Web      |     ❌     |
+
+## Installation
+
+To install the `flet-ads` package and add it to your project dependencies:
+
+- Using `uv`:
+    ```bash
+    uv add flet-ads
+    ```
+
+- Using `pip`:
+    ```bash
+    pip install flet-ads
+    ```
+    After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
+
+- Using `poetry`:
+    ```bash
+    poetry add flet-ads
+    ```
+
+## Examples
+
+For examples, see [this](./examples)

flet_ads-0.2.0.dev34/pyproject.toml

@@ -0,0 +1,68 @@
+[project]
+name = "flet-ads"
+version = "0.2.0.dev34"
+description = "Display Google Ads in Flet apps."
+readme = "README.md"
+authors = [{ name = "Flet contributors", email = "hello@flet.dev" }]
+license = "Apache-2.0"
+requires-python = ">=3.10"
+dependencies = [
+    "flet >=0.70.0",
+]
+
+[project.urls]
+Homepage = "https://flet.dev"
+Documentation = "https://flet-dev.github.io/flet-ads"
+Repository = "https://github.com/flet-dev/flet-ads"
+Issues = "https://github.com/flet-dev/flet-ads/issues"
+
+[dependency-groups]
+dev = [
+    "pre-commit>=4.2.0",
+    "ruff>=0.11.7",
+]
+docs = [
+    "mkdocs",
+    "mkdocs-material",
+    "mkdocstrings[python]",
+    "mkdocstrings-python-xref",
+    "mike",
+    "markdown>=3.6",
+    "pymdown-extensions",
+    "mkdocs-glightbox",
+    "mkdocs-section-index",
+    "griffe-modernized-annotations",
+    "pygments>=2.16",
+]
+
+[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"
+]
+preview = true
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "auto"

flet_ads-0.2.0.dev34/src/flet_ads/__init__.py

@@ -0,0 +1,10 @@
+from .banner_ad import BannerAd
+from .base_ad import BaseAd
+from .interstitial_ad import InterstitialAd
+from .types import (  # NativeAdTemplateStyle,; NativeAdTemplateTextStyle,; NativeAdTemplateType,; NativeTemplateFontStyle,
+    AdRequest,
+    PaidAdEvent,
+    PrecisionType,
+)
+
+# from .native_ad import NativeAd

flet_ads-0.2.0.dev34/src/flet_ads/banner_ad.py

@@ -0,0 +1,29 @@
+import flet as ft
+
+from .base_ad import BaseAd
+from .types import PaidAdEvent
+
+
+@ft.control("BannerAd")
+class BannerAd(BaseAd):
+    """
+    Displays a banner ad.
+
+    Raises:
+        AssertionError: When using this control on a web and/or non-mobile platform.
+    """
+
+    on_will_dismiss: ft.OptionalControlEventHandler["BannerAd"] = None
+    """
+    Called before dismissing a full screen view.
+
+    Note:
+        Only available on iOS.
+    """
+
+    on_paid: ft.OptionalControlEventHandler[PaidAdEvent["BannerAd"]] = None
+    """
+    Called when this ad is estimated to have earned money.
+
+    Available for allowlisted accounts only.
+    """

flet_ads-0.2.0.dev34/src/flet_ads/base_ad.py

@@ -0,0 +1,67 @@
+from dataclasses import field
+
+import flet as ft
+
+from flet_ads.types import AdRequest
+
+
+@ft.control
+class BaseAd(ft.Control):
+    """
+    Base class for all ad controls in Flet Ads package.
+
+    Raises:
+        AssertionError: When using this control on a web and/or non-mobile platform.
+    """
+
+    unit_id: str
+    """
+    Ad unit ID for this ad.
+    """
+
+    request: AdRequest = field(default_factory=lambda: AdRequest())
+    """
+    Targeting information used to fetch an Ad.
+    """
+
+    on_load: ft.OptionalControlEventHandler["BaseAd"] = None
+    """
+    Called when this ad is loaded successfully.
+    """
+
+    on_error: ft.OptionalControlEventHandler["BaseAd"] = None
+    """
+    Called when an ad request failed.
+    
+    Event handler argument `data` property contains information about the error.
+    """
+
+    on_open: ft.OptionalControlEventHandler["BaseAd"] = None
+    """
+    Called when this ad opens up.
+    
+    A full screen view/overlay is presented in response to the user clicking
+    on an ad. You may want to pause animations and time sensitive
+    interactions.
+    """
+
+    on_close: ft.OptionalControlEventHandler["BaseAd"] = None
+    """
+    Called when the full screen view has been closed. You should restart
+    anything paused while handling [`on_open`][..].
+    """
+
+    on_impression: ft.OptionalControlEventHandler["BaseAd"] = None
+    """
+    Called when an impression occurs on this ad.
+    """
+
+    on_click: ft.OptionalControlEventHandler["BaseAd"] = None
+    """
+    Called when this ad is clicked.
+    """
+
+    def before_update(self):
+        assert (
+            not self.page.web and self.page.platform.is_mobile()
+        ), f"{self.__class__.__name__} is only supported on Mobile (Android and iOS)"

flet_ads-0.2.0.dev34/src/flet_ads/interstitial_ad.py

@@ -0,0 +1,21 @@
+import asyncio
+
+import flet as ft
+
+from .base_ad import BaseAd
+
+
+@ft.control("InterstitialAd")
+class InterstitialAd(BaseAd):
+    """
+    Displays a full-screen interstitial ad.
+
+    Raises:
+        AssertionError: When using this control on a web and/or non-mobile platform.
+    """
+
+    def show(self):
+        asyncio.create_task(self.show_async())
+
+    async def show_async(self):
+        await self._invoke_method_async("show")

flet_ads-0.2.0.dev34/src/flet_ads/native_ad.py

@@ -0,0 +1,32 @@
+import flet as ft
+
+from .banner_ad import BannerAd
+from .types import NativeAdTemplateStyle
+
+__all__ = ["NativeAd"]
+
+
+@ft.control("NativeAd")
+class NativeAd(BannerAd):
+    """
+    Renders a native ad.
+
+    Raises:
+        AssertionError: When neither [`factory_id`][..] nor [`template_style`][..] is set.
+    """
+
+    factory_id: str = None
+    """
+    An identifier for the factory that creates the Platform view.
+    """
+
+    template_style: NativeAdTemplateStyle = None
+    """
+    A style for the native ad template.
+    """
+
+    def before_update(self):
+        super().before_update()
+        assert (
+            self.factory_id is not None or self.template_style is not None
+        ), "factory_id or template_style must be set"

flet_ads-0.2.0.dev34/src/flet_ads/types.py

@@ -0,0 +1,129 @@
+from dataclasses import dataclass
+from enum import Enum
+from typing import Optional
+
+import flet as ft
+
+__all__ = [
+    "PrecisionType",
+    "PaidAdEvent",
+    "AdRequest",
+    "NativeAdTemplateType",
+    "NativeTemplateFontStyle",
+    "NativeAdTemplateTextStyle",
+    "NativeAdTemplateStyle",
+]
+
+
+class PrecisionType(Enum):
+    UNKNOWN = "unknown"
+    """An ad value with unknown precision."""
+
+    ESTIMATED = "estimated"
+    """An ad value estimated from aggregated data."""
+
+    PUBLISHER_PROVIDED = "publisherProvided"
+    """A publisher-provided ad value, such as manual CPMs in a mediation group."""
+
+    PRECISE = "precise"
+    """The precise value paid for this ad."""
+
+
+@dataclass
+class PaidAdEvent(ft.Event[ft.EventControlType]):
+    """
+    Event data for paid ad events.
+    """
+
+    value: float
+    """
+    The monetary value of the ad.
+    """
+
+    precision: PrecisionType
+    """
+    The precision of the ad value.
+    """
+
+    currency_code: str
+    """
+    The currency code of the ad value.
+    """
+
+
+@dataclass
+class AdRequest:
+    """
+    Targeting info per the AdMob API.
+
+    This class's properties mirror the native AdRequest API. See for example:
+    [AdRequest.Builder for Android](https://developers.google.com/android/reference/com/google/android/gms/ads/AdRequest.Builder).
+    """
+
+    keywords: Optional[list[str]] = None
+    """
+    Words or phrases describing the current user activity.
+    """
+
+    content_url: Optional[str] = None
+    """
+    URL string for a webpage whose content matches the app’s primary content.
+
+    This webpage content is used for targeting and brand safety purposes.
+    """
+
+    neighboring_content_urls: Optional[list[str]] = None
+    """
+    URLs representing web content near an ad.
+    """
+
+    non_personalized_ads: Optional[bool] = None
+    """
+    Non-personalized ads are ads that are not based on a user’s past behavior.
+
+    For more information: https://support.google.com/admob/answer/7676680?hl=en
+    """
+
+    http_timeout: Optional[int] = None
+    """
+    A custom timeout (in milliseconds) for HTTPS calls during an ad request.
+
+    Note:
+        This is only supported in Android. (ignored on iOS)
+    """
+
+    extras: Optional[dict[str, str]] = None
+    """
+    Extras to pass to the AdMob adapter.
+    """
+
+
+class NativeAdTemplateType(Enum):
+    SMALL = "small"
+    MEDIUM = "medium"
+
+
+class NativeTemplateFontStyle(Enum):
+    NORMAL = "normal"
+    BOLD = "bold"
+    ITALIC = "italic"
+    MONOSPACE = "monospace"
+
+
+@dataclass
+class NativeAdTemplateTextStyle:
+    size: Optional[ft.Number] = None
+    text_color: Optional[ft.ColorValue] = None
+    bgcolor: Optional[ft.ColorValue] = None
+    style: Optional[NativeTemplateFontStyle] = None
+
+
+@dataclass
+class NativeAdTemplateStyle:
+    template_type: NativeAdTemplateType = NativeAdTemplateType.MEDIUM
+    main_bgcolor: Optional[ft.ColorValue] = None
+    corner_radius: Optional[ft.Number] = None
+    call_to_action_text_style: Optional[NativeAdTemplateTextStyle] = None
+    primary_text_style: Optional[NativeAdTemplateTextStyle] = None
+    secondary_text_style: Optional[NativeAdTemplateTextStyle] = None
+    tertiary_text_style: Optional[NativeAdTemplateTextStyle] = None

flet_ads-0.2.0.dev34/src/flet_ads.egg-info/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: flet-ads
+Version: 0.2.0.dev34
+Summary: Display Google Ads in Flet apps.
+Author-email: Flet contributors <hello@flet.dev>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://flet.dev
+Project-URL: Documentation, https://flet-dev.github.io/flet-ads
+Project-URL: Repository, https://github.com/flet-dev/flet-ads
+Project-URL: Issues, https://github.com/flet-dev/flet-ads/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flet>=0.70.0
+Dynamic: license-file
+
+# flet-ads
+
+[![pypi](https://img.shields.io/pypi/v/flet-ads.svg)](https://pypi.python.org/pypi/flet-ads)
+[![downloads](https://static.pepy.tech/badge/flet-ads/month)](https://pepy.tech/project/flet-ads)
+[![license](https://img.shields.io/github/license/flet-dev/flet-ads.svg)](https://github.com/flet-dev/flet-ads/blob/main/LICENSE)
+
+Display Google Ads in [Flet](https://flet.dev) apps.
+
+It is based on the [google_mobile_ads](https://pub.dev/packages/google_mobile_ads) Flutter package.
+
+## Documentation
+
+Detailed documentation to this package can be found [here](https://flet-dev.github.io/flet-ads/).
+
+## Platform Support
+
+This package supports the following platforms:
+
+| Platform | Supported |
+|----------|:---------:|
+| Windows  |     ❌     |
+| macOS    |     ❌     |
+| Linux    |     ❌     |
+| iOS      |     ✅     |
+| Android  |     ✅     |
+| Web      |     ❌     |
+
+## Installation
+
+To install the `flet-ads` package and add it to your project dependencies:
+
+- Using `uv`:
+    ```bash
+    uv add flet-ads
+    ```
+
+- Using `pip`:
+    ```bash
+    pip install flet-ads
+    ```
+    After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
+
+- Using `poetry`:
+    ```bash
+    poetry add flet-ads
+    ```
+
+## Examples
+
+For examples, see [this](./examples)

flet_ads-0.2.0.dev34/src/flet_ads.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+src/flet_ads/__init__.py
+src/flet_ads/banner_ad.py
+src/flet_ads/base_ad.py
+src/flet_ads/interstitial_ad.py
+src/flet_ads/native_ad.py
+src/flet_ads/types.py
+src/flet_ads.egg-info/PKG-INFO
+src/flet_ads.egg-info/SOURCES.txt
+src/flet_ads.egg-info/dependency_links.txt
+src/flet_ads.egg-info/requires.txt
+src/flet_ads.egg-info/top_level.txt

flet_ads-0.2.0.dev34/src/flet_ads.egg-info/requires.txt

@@ -0,0 +1 @@
+flet>=0.70.0

flet_ads-0.1.0/PKG-INFO

@@ -1,97 +0,0 @@
-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)
-```