android-notify 1.50.1__py3-none-any.whl → 1.51.1__py3-none-any.whl

android_notify/styles.py

@@ -1,15 +1,16 @@
+"""Contains Safe way to call Styles"""
+
 class NotificationStyles():
     """ Safely Adding Styles"""
     DEFAULT = "simple"
-    
+
     PROGRESS = "progress"
     INBOX = "inbox"
     BIG_TEXT = "big_text"
-    
+
     LARGE_ICON = "large_icon"
     BIG_PICTURE = "big_picture"
     BOTH_IMGS = "both_imgs"
-    
+
     MESSAGING = "messaging" # TODO
     CUSTOM = "custom" # TODO
-    

android_notify/sword.py

@@ -2,15 +2,19 @@
 import difflib
 import traceback
 import os
+import threading
 import re
+from .styles import NotificationStyles
 
 DEV=0
 ON_ANDROID = False
 
 try:
+    # Android Imports
     from jnius import autoclass,cast  # Needs Java to be installed pylint: disable=W0611, C0114
     from android import activity # pylint: disable=import-error
     from android.config import ACTIVITY_CLASS_NAME # pylint: disable=import-error
+    from android.runnable import run_on_ui_thread # pylint: disable=import-error
 
     # Get the required Java classes
     Bundle = autoclass('android.os.Bundle')
@@ -28,6 +32,14 @@ except Exception as e:# pylint: disable=W0718
     MESSAGE='This Package Only Runs on Android !!! ---> Check "https://github.com/Fector101/android_notify/" to see design patterns and more info.' # pylint: disable=C0301
     print(MESSAGE if DEV else '')
 
+    # This is so no crashes when developing on PC
+    def run_on_ui_thread(func):
+        """Fallback for Developing on PC"""
+        def wrapper(*args, **kwargs):
+            print("Simulating run on UI thread")
+            return func(*args, **kwargs)
+        return wrapper
+
 if ON_ANDROID:
     try:
         from android.permissions import request_permissions, Permission,check_permission # pylint: disable=E0401
@@ -62,9 +74,12 @@ class Notification:
     both_imgs == using lager icon and big picture
     :param big_picture_path: Relative Path to the image resource.
     :param large_icon_path: Relative Path to the image resource.
-    :param callback: Function for notification Click.
+    :param progress_current_value: interger To set progress bar current value.
+    :param progress_max_value: interger To set Max range for progress bar.
+    :param subject: Preview text For `big_Text` style `message`.
     ---
     (Advance Options)
+    :param callback: Function for notification Click.
     :param channel_name: - str Defaults to "Default Channel"
     :param channel_id: - str Defaults to "default_channel"
     ---
@@ -84,18 +99,23 @@ class Notification:
                 ] # TODO make pattern for non-android Notifications
     defaults={
         'title':'Default Title',
-        'message':'Default Message', # TODO Might change message para to list if style set to inbox
+        'message':'Default Message',
         'style':'simple',
         'big_picture_path':'',
         'large_icon_path':'',
         'progress_max_value': 0,
         'progress_current_value': 0,
+        'subject':'',
         'channel_name':'Default Channel',
         'channel_id':'default_channel',
         'logs':True,
         "identifer": '',
         'callback': None
     }
+    # TODO specify types in a better way instead of using
+    # if key not in non_string_keys: value = str(value) to fix
+    #non_string_keys=['progress_max_value','progress_current_value','callback','logs']
+    # TODO using default values to check types
     # During Development (When running on PC)
     logs=not ON_ANDROID
     def __init__(self,**kwargs):
@@ -108,6 +128,7 @@ class Notification:
         self.big_picture_path=''
         self.progress_current_value=0
         self.progress_max_value=0
+        self.subject= ''
 
         # For Nofitication Functions
         self.identifer=''
@@ -151,14 +172,17 @@ class Notification:
         self.message=new_message
         if ON_ANDROID:
             self.__builder.setContentText(new_message)
-
+            return True
+        return 'Updated'
     def updateProgressBar(self,current_value,message:str=''):
-        """message defaults to last message"""
-        if not ON_ANDROID:
-            return
+        """current_value is the value to set progressbar, message defaults to last message"""
 
         if self.logs:
             print(f'Progress Bar Update value: {current_value}')
+
+        if not ON_ANDROID:
+            return
+
         self.__builder.setProgress(self.progress_max_value, current_value, False)
         if message:
             self.__builder.setContentText(String(message))
@@ -166,8 +190,16 @@ class Notification:
 
     def removeProgressBar(self,message=''):
         """message defaults to last message"""
+
+        if self.logs:
+            print('removed')
+
+        if not ON_ANDROID:
+            return True
+
         if message:
             self.__builder.setContentText(String(message))
+            return True
         self.__builder.setProgress(0, 0, False)
         self.notification_manager.notify(self.__id, self.__builder.build())
 
@@ -183,8 +215,9 @@ class Notification:
             self.notification_manager.notify(self.__id, self.__builder.build())
         elif self.logs:
             string_to_display=''
+            print("\n Sent Notification!!!")
             for name,value in vars(self).items():
-                if value and name not in ['logs','_Notification__id']:
+                if value and name in ["title", "message", "style", "subject", "large_icon_path", "big_picture_path", "progress_current_value", "progress_max_value", "channel_name"]:
                     string_to_display += f'\n {name}: {value}'
             string_to_display +="\n (Won't Print Logs When Complied,except if selected `Notification.logs=True`)"
             print(string_to_display)
@@ -254,63 +287,48 @@ class Notification:
             self.notification_manager.createNotificationChannel(channel)
 
         # Build the notification
-        # self.__builder = NotificationCompatBuilder(context, self.channel_id)# pylint: disable=E0606
+        # str() This is to prevent Error When user does Notification.title='blah' instead of Notification(title='blah'
+        # TODO fix this by creating a on_Title method in other versions
         self.__builder.setContentTitle(str(self.title))
-        self.__builder.setContentText(str(self.message))
+        if self.style == NotificationStyles.BIG_TEXT:
+            self.__builder.setContentText(str(self.subject))
+        else:
+            self.__builder.setContentText(str(self.message))
         self.__builder.setSmallIcon(context.getApplicationInfo().icon)
         self.__builder.setDefaults(NotificationCompat.DEFAULT_ALL) # pylint: disable=E0606
         self.__builder.setPriority(NotificationCompat.PRIORITY_DEFAULT if self.silent else NotificationCompat.PRIORITY_HIGH)
+        self.__builder.setOnlyAlertOnce(True)
         self.__addIntentToOpenApp()
+
     def __addNotificationStyle(self):
-        # pylint: disable=trailing-whitespace
-        
-        large_icon_javapath=None
-        if self.large_icon_path:
-            try:
-                large_icon_javapath = self.__get_image_uri(self.large_icon_path)
-            except FileNotFoundError as e:
-                print('Failed Adding Big Picture Bitmap: ',e)
-        
-        big_pic_javapath=None
-        if self.big_picture_path:
-            try:
-                big_pic_javapath = self.__get_image_uri(self.big_picture_path)
-            except FileNotFoundError as e:
-                print('Failed Adding Lagre Icon Bitmap: ',e)
-        
-        
-        if self.style == "big_text":
+        if self.style == NotificationStyles.BIG_TEXT:
             big_text_style = NotificationCompatBigTextStyle() # pylint: disable=E0606
             big_text_style.bigText(self.message)
             self.__builder.setStyle(big_text_style)
-            
-        elif self.style == "inbox":
+
+        elif self.style == NotificationStyles.INBOX:
             inbox_style = NotificationCompatInboxStyle() # pylint: disable=E0606
             for line in self.message.split("\n"):
                 inbox_style.addLine(line)
             self.__builder.setStyle(inbox_style)
-            
-        elif self.style == "big_picture" and big_pic_javapath:
-            big_pic_bitmap = self.__getBitmap(big_pic_javapath)
-            big_picture_style = NotificationCompatBigPictureStyle().bigPicture(big_pic_bitmap) # pylint: disable=E0606
-            self.__builder.setStyle(big_picture_style)
-        
-        elif self.style == "large_icon" and large_icon_javapath:
-            large_icon_bitmap = self.__getBitmap(large_icon_javapath)
-            self.__builder.setLargeIcon(large_icon_bitmap)
-        
-        elif self.style == 'both_imgs' and (large_icon_javapath or big_pic_javapath):
-            if big_pic_javapath:
-                big_pic_bitmap = self.__getBitmap(big_pic_javapath)
-                big_picture_style = NotificationCompatBigPictureStyle().bigPicture(big_pic_bitmap)
-                self.__builder.setStyle(big_picture_style)
-            if large_icon_javapath:
-                large_icon_bitmap = self.__getBitmap(large_icon_javapath)
-                self.__builder.setLargeIcon(large_icon_bitmap)
+
+        elif self.style == NotificationStyles.BIG_PICTURE and self.big_picture_path:
+            self.__buildImg(self.big_picture_path, self.style)
+
+        elif self.style == NotificationStyles.LARGE_ICON and self.large_icon_path:
+            self.__buildImg(self.large_icon_path, self.style)
+
+        elif self.style == NotificationStyles.BOTH_IMGS and (self.big_picture_path or self.large_icon_path):
+            if self.big_picture_path:
+                self.__buildImg(self.big_picture_path, NotificationStyles.BIG_PICTURE)
+            if self.large_icon_path:
+                self.__buildImg(self.large_icon_path, NotificationStyles.LARGE_ICON)
+
         elif self.style == 'progress':
             self.__builder.setContentTitle(String(self.title))
             self.__builder.setContentText(String(self.message))
             self.__builder.setProgress(self.progress_max_value, self.progress_current_value, False)
+
         # elif self.style == 'custom':
         #     self.__builder = self.__doCustomStyle()
 
@@ -318,6 +336,67 @@ class Notification:
     #     # TODO Will implement when needed
     #     return self.__builder
 
+    def __buildImg(self, user_img,img_style):
+        if user_img.startswith('http://') or user_img.startswith('https://'):
+            thread = threading.Thread(
+                                        target=self.__getImgFromURL,
+                                        args=(user_img,img_style,)
+                                    )
+            thread.start()
+        else:
+            if NotificationStyles.BIG_PICTURE:
+                bitmap = self.__getImgFromPath(user_img)
+                if bitmap:
+                    big_picture_style = NotificationCompatBigPictureStyle().bigPicture(bitmap) # pylint: disable=E0606
+                    self.__builder.setStyle(big_picture_style)
+            elif NotificationStyles.LARGE_ICON:
+                bitmap = self.__getImgFromPath(user_img)
+                if bitmap:
+                    self.__builder.setLargeIcon(bitmap)
+
+    def __getImgFromPath(self, relative_path):
+        app_folder=os.path.join(app_storage_path(),'app') # pylint: disable=possibly-used-before-assignment
+        output_path = os.path.join(app_folder, relative_path)
+        if not os.path.exists(output_path):
+            print(f"\nImage not found at path: {output_path}, (Local images gotten from App Path)")
+            print("These are the existing files in your app Folder:")
+            print('['+', '.join(os.listdir(app_folder)) + ']')
+            return None
+        Uri = autoclass('android.net.Uri')
+        uri = Uri.parse(f"file://{output_path}")
+        return BitmapFactory.decodeStream(context.getContentResolver().openInputStream(uri))
+
+    def __getImgFromURL(self,url,img_style):
+        print("getting image from URL---")
+        try:
+            URL = autoclass('java.net.URL')
+            url = URL(url)
+            connection = url.openConnection()
+            connection.connect()
+            input_stream = connection.getInputStream()
+            bitmap = BitmapFactory.decodeStream(input_stream)
+            input_stream.close()
+            self.__applyNotificationImage(bitmap,img_style)
+        except Exception as e:
+            # TODO get type of JAVA Error
+            print('Error Type ',e)
+            print('Failed to get Img from URL ',traceback.format_exc())
+
+    @run_on_ui_thread
+    def __applyNotificationImage(self,bitmap,img_style):
+        print('appying notification image thread ', bitmap)
+        try:
+            if img_style == NotificationStyles.BIG_PICTURE:
+                big_picture_style = NotificationCompatBigPictureStyle().bigPicture(bitmap) # pylint: disable=E0606
+                self.__builder.setStyle(big_picture_style)
+            elif img_style == NotificationStyles.LARGE_ICON:
+                self.__builder.setLargeIcon(bitmap)
+            self.notification_manager.notify(self.__id, self.__builder.build())
+            print('added notification image done-------')
+        except Exception as e:
+            print('I could stop ',e)
+            print('could stop get Img from URL ',traceback.format_exc())
+
     def __getUniqueID(self):
         notification_id = self.notification_ids[-1] + 1
         self.notification_ids.append(notification_id)
@@ -335,24 +414,6 @@ class Notification:
         if not all(check_permission(p) for p in permissions):
             request_permissions(permissions,on_permissions_result) # pylint: disable=E0606
 
-    def __get_image_uri(self,relative_path):
-        """
-        Get the absolute URI for an image in the assets folder.
-        :param relative_path: The relative path to the image (e.g., 'assets/imgs/icon.png').
-        :return: Absolute URI java Object (e.g., 'file:///path/to/file.png').
-        """
-
-        output_path = os.path.join(app_storage_path(),'app', relative_path) # pylint: disable=possibly-used-before-assignment
-        # print(output_path)  # /data/user/0/(package.domain+package.name)/files/app/assets/imgs/icon.png | pylint: disable=:line-too-long
-
-        if not os.path.exists(output_path):
-            # TODO Use images From Any where even Web
-            raise FileNotFoundError(f"Image not found at path: {output_path}, (Can Only Use Images in App Path)")
-        Uri = autoclass('android.net.Uri')
-        return Uri.parse(f"file://{output_path}")
-    def __getBitmap(self,img_path):
-        return BitmapFactory.decodeStream(context.getContentResolver().openInputStream(img_path))
-
     def __generate_channel_id(self,channel_name: str) -> str:
         """
         Generate a readable and consistent channel ID from a channel name.
@@ -451,6 +512,7 @@ class Notification:
 class NotificationHandler:
     """For Notification Operations """
     __identifer = None
+    __bound = False
 
     @classmethod
     def getIdentifer(cls):
@@ -516,9 +578,13 @@ class NotificationHandler:
         """This Creates a Listener for All Notification Clicks and Functions"""
         if not cls.is_on_android():
             return "Not on Android"
-        #Beta TODO Automatic bind when Notification object is called the first time use keep trying BroadcastReceiver
+        #TODO keep trying BroadcastReceiver
+        if cls.__bound:
+            print("bounding done already ")
+            return True
         try:
             activity.bind(on_new_intent=cls.__notificationHandler)
+            cls.__bound = True
             return True
         except Exception as e: # pylint: disable=broad-exception-caught
             print('Failed to bin notitfications listener',e)
@@ -541,3 +607,5 @@ class NotificationHandler:
     def is_on_android():
         """Utility to check if the app is running on Android."""
         return ON_ANDROID
+
+NotificationHandler.bindNotifyListener()

{android_notify-1.50.1.dist-info → android_notify-1.51.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: android-notify
-Version: 1.50.1
+Version: 1.51.1
 Summary: A Python package that simpilfies creating Android notifications in Kivy apps.
 Home-page: https://github.com/fector101/android-notify
 Author: Fabian
@@ -47,7 +47,7 @@ Dynamic: summary
 
 - Also Compatible with Android 8.0+.
 - Supports including images in notifications.
-- All Notifications can take Functions (version 1.50+) [functions docs](#functions).
+- All Notifications can take Functions (version 1.50+) [functions section](#functions).
 - Support for multiple notification styles:
   - [Simple](#basic-usage)
   - [Progress](#progress-bar-notification)
@@ -88,6 +88,7 @@ android.permissions = POST_NOTIFICATIONS
 # Required dependencies (write exactly as shown, no quotation marks)
 android.gradle_dependencies = androidx.core:core:1.6.0, androidx.core:core-ktx:1.15.0
 android.enable_androidx = True
+android.api = 35
 ```
 
 ---
@@ -142,7 +143,14 @@ Clock.schedule_once(lambda dt: notification.updateProgressBar(30, "30% downloade
 **Sample Image:**
 ![progress img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/progress.jpg)
 
-#### Notification with an Image (Big Picture Style)
+#### Images
+
+##### Notification with an Image (Big Picture Style)
+
+> [!NOTE]
+> Online Images should start with `http://` or `https://`  
+> And request for permission, `android.permissions = INTERNET`  
+> No additionally permissions needed for images in App folder
 
 ```python
 # Image notification
@@ -159,36 +167,36 @@ notification.send()
 **Sample Image:**
 ![big_picture img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/bigpicturenoti.jpg)
 
-#### Inbox Notification Style
+##### Notification with an Image (Large Icon Style)
 
 ```python
-# Send a notification with inbox style
 notification = Notification(
-    title='Inbox Notification',
-    message='Line 1\nLine 2\nLine 3',
-    style='inbox'
+    title="FabianDev_",
+    message="A twitter about some programming stuff",
+    style="large_icon",
+    large_icon_path="assets/imgs/profile.png"
 )
-notification.send()
 
 ```
 
-**Sample Image:**
-![Inbox Notification sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/inboxnoti.jpg)
+**Sample Image:**  
+![large_icon img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/large_icon.jpg)
 
-#### Notification with an Image (Large Icon Style)
+#### Inbox Notification Style
 
 ```python
+# Send a notification with inbox style
 notification = Notification(
-    title="FabianDev_",
-    message="A twitter about some programming stuff",
-    style="large_icon",
-    large_icon_path="assets/imgs/profile.png"
+    title='Inbox Notification',
+    message='Line 1\nLine 2\nLine 3',
+    style='inbox'
 )
+notification.send()
 
 ```
 
-**Sample Image:**  
-![large_icon img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/large_icon.jpg)
+**Sample Image:**
+![Inbox Notification sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/inboxnoti.jpg)
 
 #### Notification with Buttons
 
@@ -212,16 +220,19 @@ notification.send()
 **Sample Image:**  
 ![btns img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/btns.jpg)
 
-#### Big text notification (Will Display as normal text if Device dosen't support)
+#### Big text notification
 
 ```python
 notification = Notification(
     title="Article",
-    message="Long article content...",
+    subject="Histroy of Loerm Ipsuim",
+    message="Lorem Ipsum is simply dummy text of the printing and ...",
     style="big_text"
 )
 ```
 
+![big_text img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/big_text.jpg)
+
 ## Advanced Features
 
 ### Updating Notifications
@@ -281,19 +292,13 @@ notification.send(silent=True)
 
 ## Functions
 
-### NotificationHandler - To Attach Listener
-
-Add this to your main.py App Class so it runs Once, In later Versions It'll be Attached Automatical
-
 ```python
 from kivymd.app import MDApp
-from android_notify import Notification, NotificationHandler
+from android_notify import Notification
 
 class Myapp(MDApp):
 
     def on_start(self):
-        # Is called Once when app is Starts up
-        NotificationHandler.bindNotifyListener() # if successfull returns True
         Notification(title="Hello", message="This is a basic notification.",callback=self.doSomething).send()
 
     def doSomething(self):
@@ -318,8 +323,6 @@ class Myapp(MDApp):
         notify1 = Notification(title="Change Colour", message="Click to change App Colour", identifer='change_app_color')
         notify1.send()
 
-        NotificationHandler.bindNotifyListener()
-        
     def on_resume(self):
         # Is called everytime app is reopened
         notify_identifer = NotificationHandler.getIdentifer()
@@ -331,22 +334,8 @@ class Myapp(MDApp):
             pass
 ```
 
-
-
 ### Assist
 
-- How to Copy image to app folder
-
-```python
-import shutil,os # These modules come packaged with python
-from android.storage import app_storage_path # type: ignore -- This works only on android 
-
-app_path = os.path.join(app_storage_path(),'app')
-image_path= "/storage/emulated/0/Download/profile.png"
-
-shutil.copy(image_path, os.path.join(app_path, "profile.png"))
-```
-
 - Avoiding Human Error when using different notification styles
 
 ```python
@@ -375,9 +364,8 @@ notification.send()
 
 ## Image Requirements
 
-- Images must be located within your app's folder
-- Supported paths are relative to your app's storage path
-- Example: `assets/imgs/icon.png`
+- Online Images should start with `http://` or `https://`
+- Local Images must be located within your app's folder
 
 ## Error Handling
 
@@ -385,22 +373,20 @@ The library validates arguments and provides helpful error messages:
 
 - Invalid style names will suggest the closest matching style
 - Invalid arguments will list all valid options
-- Missing image files will raise FileNotFoundError with the attempted path
+- Missing image files will list all files in App Directory
 
-## Limitations
+## Limitation
 
 1. Only works on Android devices
-2. Images must be within the app's storage path
-3. Channel names are limited to 40 characters
-4. Channel IDs are limited to 50 characters
 
 ## Best Practices
 
 1. Always handle permissions appropriately
-2. Use meaningful channel names for organization
-3. Keep progress bar updates reasonable (don't update too frequently)
-4. Test notifications on different Android versions
-5. Consider using silent notifications for frequent updates
+2. use `NotificationStyles` to set `style`, use `style=NotificationStyles.LARGE_ICON` instead of `style="large_icon"`
+3. Use meaningful channel names for organization
+4. Keep progress bar updates reasonable (don't update too frequently)
+5. Test notifications on different Android versions
+6. Consider using silent notifications for frequent updates
 
 ## Debugging Tips
 

android_notify-1.51.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+android_notify/__init__.py,sha256=lcLjyfegXgU7cyGhfSphAOBipXwemrVkdYy3mcF6X5Y,172
+android_notify/__main__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+android_notify/core.py,sha256=B3gOgbLGGI6tz-Q_T2wmk74oggOSDX0Qz4lqj00vaFo,6114
+android_notify/styles.py,sha256=3olKruhAbTrk5OzuhDnk_Pgpv8XYk8dWFmr48Q9rQVk,352
+android_notify/sword.py,sha256=mmQM5G9lOGYGKuVCXd_t2iFeh_MHXDrWvJJlv1kU9e0,25840
+android_notify-1.51.1.dist-info/METADATA,sha256=VvBJSj8BMS9et-3viP7H5W9E6XXXTNJxRNuObw9ubx0,12737
+android_notify-1.51.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+android_notify-1.51.1.dist-info/top_level.txt,sha256=IR1ONMrRSRINZpWn2X0dL5gbWwWINsK7PW8Jy2p4fU8,15
+android_notify-1.51.1.dist-info/RECORD,,

android_notify-1.50.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-android_notify/__init__.py,sha256=lcLjyfegXgU7cyGhfSphAOBipXwemrVkdYy3mcF6X5Y,172
-android_notify/__main__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-android_notify/core.py,sha256=B3gOgbLGGI6tz-Q_T2wmk74oggOSDX0Qz4lqj00vaFo,6114
-android_notify/styles.py,sha256=I2p31qStg9DaML9U4nXRvdpGzpppK6RS-qlDKuOv_Tk,328
-android_notify/sword.py,sha256=2T9JlFRqTLDDMtqFWrn6qvYeCQsO6Aky2UlAWuIYYVY,23172
-android_notify-1.50.1.dist-info/METADATA,sha256=RLYXmIWoV6O5-DRLqvPVJ6NqMbmsnD4CZtBmo18dZGA,13165
-android_notify-1.50.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-android_notify-1.50.1.dist-info/top_level.txt,sha256=IR1ONMrRSRINZpWn2X0dL5gbWwWINsK7PW8Jy2p4fU8,15
-android_notify-1.50.1.dist-info/RECORD,,