flet-ads 0.0.1__py3-none-any.whl → 0.70.0.dev6644__py3-none-any.whl

flet_ads/__init__.py

@@ -1 +1,17 @@
+from flet_ads.banner_ad import BannerAd
+from flet_ads.base_ad import BaseAd
+from flet_ads.interstitial_ad import InterstitialAd
+from flet_ads.types import (
+    AdRequest,
+    PaidAdEvent,
+    PrecisionType,
+)
 
+__all__ = [
+    "AdRequest",
+    "BannerAd",
+    "BaseAd",
+    "InterstitialAd",
+    "PaidAdEvent",
+    "PrecisionType",
+]

flet_ads/banner_ad.py

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

flet_ads/base_ad.py

@@ -0,0 +1,71 @@
+from dataclasses import field
+from typing import Optional
+
+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:
+        FletUnsupportedPlatformException: 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: Optional[ft.ControlEventHandler["BaseAd"]] = None
+    """
+    Called when this ad is loaded successfully.
+    """
+
+    on_error: Optional[ft.ControlEventHandler["BaseAd"]] = None
+    """
+    Called when an ad request failed.
+
+    Event handler argument [`data`][flet.Event.data] property
+    contains information about the error.
+    """
+
+    on_open: Optional[ft.ControlEventHandler["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: Optional[ft.ControlEventHandler["BaseAd"]] = None
+    """
+    Called when the full screen view has been closed. You should restart
+    anything paused while handling [`on_open`][flet_ads.BaseAd.on_open].
+    """
+
+    on_impression: Optional[ft.ControlEventHandler["BaseAd"]] = None
+    """
+    Called when an impression occurs on this ad.
+    """
+
+    on_click: Optional[ft.ControlEventHandler["BaseAd"]] = None
+    """
+    Called when this ad is clicked.
+    """
+
+    def before_update(self):
+        if self.page.web or not self.page.platform.is_mobile():
+            raise ft.FletUnsupportedPlatformException(
+                f"{self.__class__.__name__} is only supported on "
+                f"Mobile (Android and iOS)"
+            )

flet_ads/interstitial_ad.py

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

flet_ads/native_ad.py

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

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__ = [
+    "AdRequest",
+    "NativeAdTemplateStyle",
+    "NativeAdTemplateTextStyle",
+    "NativeAdTemplateType",
+    "NativeTemplateFontStyle",
+    "PaidAdEvent",
+    "PrecisionType",
+]
+
+
+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.70.0.dev6644.dist-info/METADATA

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: flet-ads
+Version: 0.70.0.dev6644
+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://docs.flet.dev/ads
+Project-URL: Repository, https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet-ads
+Project-URL: Issues, https://github.com/flet-dev/flet/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flet==0.70.0.dev6644
+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/badge/License-Apache_2.0-green.svg)](https://github.com/flet-dev/flet/blob/main/sdk/python/packages/flet-ads/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://docs.flet.dev/ads/).
+
+## Platform Support
+
+| Platform | Windows | macOS | Linux | iOS | Android | Web |
+|----------|---------|-------|-------|-----|---------|-----|
+| Supported|    ❌    |   ❌   |   ❌   |  ✅  |    ✅    |  ❌  |
+
+## Usage
+
+### 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`.
+
+### Examples
+
+For examples, see [these](https://github.com/flet-dev/flet/tree/main/sdk/python/examples/controls/ads).

flet_ads-0.70.0.dev6644.dist-info/RECORD

@@ -0,0 +1,21 @@
+flet_ads/__init__.py,sha256=tm30fkWLlgwJXpjTg784n4xeh_Box2UfZ-B4ULugq_s,334
+flet_ads/banner_ad.py,sha256=IlJ6-07pCgbZFqq-3GFSniurnBg21yEoQTNRmXtig0c,725
+flet_ads/base_ad.py,sha256=8jZhIEmtJNPHnJygF8MxH42iBEMgZ95ufCE2lgUdUJA,1929
+flet_ads/interstitial_ad.py,sha256=Ep2ba5cIgNAP0PCYqq6Uw-v6zCHgSgyfq3i9Q2ySPeI,373
+flet_ads/native_ad.py,sha256=OsOnXXspzQZZNK5jMKwHbWqD0AgBpJVgrpOmWqmBAIw,835
+flet_ads/types.py,sha256=MXAOSoYR5s8LtRYPv9zaD8L8jpReUT1tD7rhw5qDFg8,3212
+flet_ads-0.70.0.dev6644.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+flutter/flet_ads/analysis_options.yaml,sha256=32kjGAc-zF87inWaH5M46yGZWQDTwrwfvNLHeAocfG4,154
+flutter/flet_ads/pubspec.lock,sha256=f5TzY_rAJwNfQvrIA5HgAGuWamOowx0DpNGRIUUV-lc,24477
+flutter/flet_ads/pubspec.yaml,sha256=qA5sskja1AMBw4W02P_irD7tADR6cjich-98bIz34Lw,376
+flutter/flet_ads/lib/flet_ads.dart,sha256=O4dLFzsJpssVAzdKCMC14t3ihcO4K5rqhI1Qlx4Yllo,63
+flutter/flet_ads/lib/src/banner.dart,sha256=HYRJYgMhSFH3Yps9sJNq2dG4kweJ8odPrepQR5Tu0WA,2674
+flutter/flet_ads/lib/src/extension.dart,sha256=xKkuqEgp7RIKY2HYLq-Ys-agRme1rkAq5uTw-R4U998,965
+flutter/flet_ads/lib/src/interstitial.dart,sha256=H1-DRdaOd-ZBy8F91iih-Wp6fm4tGf5QWGchVstnys0,2354
+flutter/flet_ads/lib/src/native.dart,sha256=aV4XBl2xmOtesqbY-SLpsqGexp42aDk3w4RGRDK09Jg,2600
+flutter/flet_ads/lib/utils/ads.dart,sha256=ysJUvop1pTlnfHUlNWL57S_7AxKiD3hRf0K7XJZHTpo,464
+flutter/flet_ads/lib/utils/native.dart,sha256=iSIOUspBoUdtObDyrWOz-0Yuv4gs79ZyJYTe_-ZAFJQ,2013
+flet_ads-0.70.0.dev6644.dist-info/METADATA,sha256=39OmiMr3Vp9W1xmEwbZ9PQE7IqgSzX7Mk443BpGE7nI,1861
+flet_ads-0.70.0.dev6644.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+flet_ads-0.70.0.dev6644.dist-info/top_level.txt,sha256=Pguk7IG_usM8ZGyS1kjv-mZZhGKthm_734FmTIqDLBE,17
+flet_ads-0.70.0.dev6644.dist-info/RECORD,,

{flet_ads-0.0.1.dist-info → flet_ads-0.70.0.dev6644.dist-info}/WHEEL

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

flet_ads-0.70.0.dev6644.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   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.

flet_ads-0.70.0.dev6644.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+flet_ads
+flutter

flutter/flet_ads/analysis_options.yaml

@@ -0,0 +1,4 @@
+include: package:flutter_lints/flutter.yaml
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options

flutter/flet_ads/lib/flet_ads.dart

@@ -0,0 +1,3 @@
+library flet_ads;
+
+export "src/extension.dart" show Extension;