android-notify 1.52.5__tar.gz → 1.53__tar.gz

{android_notify-1.52.5 → android_notify-1.53}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: android-notify
-Version: 1.52.5
+Version: 1.53
 Summary: A Python package that simpilfies creating Android notifications in Kivy apps.
 Home-page: https://github.com/fector101/android-notify
 Author: Fabian
@@ -49,6 +49,7 @@ Dynamic: summary
 - Supports including images in notifications.
 - All Notifications can take Functions (version 1.50+) [functions section](#functions).
 - Advanced Notification Handling [section](#advanced-features).
+- Changing default app notification icon with PNG,
 - Support for multiple notification styles:
   - [Simple](#basic-usage)
   - [Progress](#progress-bar-notification)
@@ -58,10 +59,13 @@ Dynamic: summary
   - [Buttons](#notification-with-buttons)
   - [Big Text](#big-text-notification)
 
+- persistenting notification [section](#methods)
+
 This module automatically handles:
 
 - Permission requests for notifications
 - Customizable notification channels.
+- Opening app on notification click
 
 ## Installation
 
@@ -128,6 +132,7 @@ The library supports multiple notification styles:
 #### Progress Bar notification
 
 ```python
+from kivy.clock import Clock
 
 progress = 0
 
@@ -207,6 +212,8 @@ notification.send()
 
 #### Notification with Buttons
 
+Here's a sample of how to add buttons below, To Remove Buttons Simply Call the `removeButtons` method on the Notification Instance
+
 ```python
 notification = Notification(title="Jane Dough", message="How to use android-notify #coding #purepython")
 def playVideo():
@@ -271,7 +278,8 @@ notification.send()
 notification.updateProgressBar(30, "30% downloaded")
 
 # Remove progress bar
-notification.removeProgressBar("Download Complete")
+# show_on_update to notification briefly after removed progressbar
+notification.removeProgressBar("Download Complete",show_on_update=True)
 ```
 
 ### Adding Style even when already sent
@@ -395,6 +403,63 @@ notification.send()
 # Will print notification properties instead of sending
 ```
 
+### Methods
+
+### Instance.**init**
+
+args
+
+- app_icon: To Change Default app icon use PNG Or Image Will display as a Black Box
+
+### Instance.send
+
+args
+
+- persistent : To make notification stay after user clicks clear All
+- close_on_click : To close notification on click
+
+### Instance.addButton
+
+args
+
+- text : Button Text
+
+### Instance.updateTitle
+
+args
+
+- new_title : String to be set as New notification Title
+
+### Instance.updateMessage
+
+args
+
+- new_message : String to be set as New notification Message
+
+### Instance.updateProgressBar
+
+args
+
+- current_value (str): the value from progressbar current progress
+- message (str,optional): defaults to last message
+
+### Instance.removeProgressBar
+
+This Removes Progress bar
+
+args
+
+- message (str, optional): notification message, Defaults to 'last message'.
+- show_on_update (bool, optional): To show notification brifely when progressbar removed. Defaults to True.
+
+### Instance.addNotificationStyle
+
+This is useful to add style after Notification is sent or Add more styles to Notification
+args
+
+- style: choosen style. All options are in the `NotificationStyles` class `['simple','progress','inbox','big_text','large_icon','big_picture','both_imgs]`
+- already_sent: specfiy if notification.send() method has already been called, it defaults to false
+
 ## Image Requirements
 
 - Online Images should start with `http://` or `https://`

{android_notify-1.52.5 → android_notify-1.53}/README.md

@@ -13,6 +13,7 @@
 - Supports including images in notifications.
 - All Notifications can take Functions (version 1.50+) [functions section](#functions).
 - Advanced Notification Handling [section](#advanced-features).
+- Changing default app notification icon with PNG,
 - Support for multiple notification styles:
   - [Simple](#basic-usage)
   - [Progress](#progress-bar-notification)
@@ -22,10 +23,13 @@
   - [Buttons](#notification-with-buttons)
   - [Big Text](#big-text-notification)
 
+- persistenting notification [section](#methods)
+
 This module automatically handles:
 
 - Permission requests for notifications
 - Customizable notification channels.
+- Opening app on notification click
 
 ## Installation
 
@@ -92,6 +96,7 @@ The library supports multiple notification styles:
 #### Progress Bar notification
 
 ```python
+from kivy.clock import Clock
 
 progress = 0
 
@@ -171,6 +176,8 @@ notification.send()
 
 #### Notification with Buttons
 
+Here's a sample of how to add buttons below, To Remove Buttons Simply Call the `removeButtons` method on the Notification Instance
+
 ```python
 notification = Notification(title="Jane Dough", message="How to use android-notify #coding #purepython")
 def playVideo():
@@ -235,7 +242,8 @@ notification.send()
 notification.updateProgressBar(30, "30% downloaded")
 
 # Remove progress bar
-notification.removeProgressBar("Download Complete")
+# show_on_update to notification briefly after removed progressbar
+notification.removeProgressBar("Download Complete",show_on_update=True)
 ```
 
 ### Adding Style even when already sent
@@ -359,6 +367,63 @@ notification.send()
 # Will print notification properties instead of sending
 ```
 
+### Methods
+
+### Instance.**init**
+
+args
+
+- app_icon: To Change Default app icon use PNG Or Image Will display as a Black Box
+
+### Instance.send
+
+args
+
+- persistent : To make notification stay after user clicks clear All
+- close_on_click : To close notification on click
+
+### Instance.addButton
+
+args
+
+- text : Button Text
+
+### Instance.updateTitle
+
+args
+
+- new_title : String to be set as New notification Title
+
+### Instance.updateMessage
+
+args
+
+- new_message : String to be set as New notification Message
+
+### Instance.updateProgressBar
+
+args
+
+- current_value (str): the value from progressbar current progress
+- message (str,optional): defaults to last message
+
+### Instance.removeProgressBar
+
+This Removes Progress bar
+
+args
+
+- message (str, optional): notification message, Defaults to 'last message'.
+- show_on_update (bool, optional): To show notification brifely when progressbar removed. Defaults to True.
+
+### Instance.addNotificationStyle
+
+This is useful to add style after Notification is sent or Add more styles to Notification
+args
+
+- style: choosen style. All options are in the `NotificationStyles` class `['simple','progress','inbox','big_text','large_icon','big_picture','both_imgs]`
+- already_sent: specfiy if notification.send() method has already been called, it defaults to false
+
 ## Image Requirements
 
 - Online Images should start with `http://` or `https://`

android_notify-1.53/android_notify/facade.py

@@ -0,0 +1,28 @@
+"""Assists Notification Class with Args auto-complete: keeps sub class cleaner"""
+from dataclasses import dataclass
+
+@dataclass
+class BaseNotification:
+    """Encapsulator"""
+    
+    # Basic options
+    title: str = ''
+    message: str = ''
+    style: str = 'simple'
+    
+    # Style specfic attributes
+    big_picture_path: str = ''
+    large_icon_path: str = ''
+    progress_max_value: int = 100
+    progress_current_value: int = 0
+    body: str = ''
+    
+    # For Nofitication Functions
+    identifer: str = ''
+    callback: object = None
+    
+    # Advance Options
+    channel_name: str = 'Default Channel'
+    channel_id: str = 'default_channel'
+    silent: bool = False
+    app_icon: str = 'Defaults to package app icon'

{android_notify-1.52.5 → android_notify-1.53}/android_notify/sword.py

@@ -4,9 +4,8 @@ import traceback
 import os
 import threading
 import re
-import time
 from .styles import NotificationStyles
-
+from .facade import BaseNotification
 DEV=0
 ON_ANDROID = False
 
@@ -28,6 +27,7 @@ try:
     BuildVersion = autoclass('android.os.Build$VERSION')
     NotificationManager = autoclass('android.app.NotificationManager')
     NotificationChannel = autoclass('android.app.NotificationChannel')
+    IconCompat = autoclass('androidx.core.graphics.drawable.IconCompat')
     ON_ANDROID = True
 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
@@ -64,7 +64,7 @@ if ON_ANDROID:
         * android.permissions = POST_NOTIFICATIONS
         """)
 
-class Notification:
+class Notification(BaseNotification):
     """
     Send a notification on Android.
 
@@ -104,43 +104,21 @@ class Notification:
         'style':'simple',
         'big_picture_path':'',
         'large_icon_path':'',
-        'progress_max_value': 0,
-        'progress_current_value': 0,
+        'progress_max_value': 0.5,
+        'progress_current_value': 0.5,
         'body':'',
         'channel_name':'Default Channel',
         'channel_id':'default_channel',
         'logs':True,
         "identifer": '',
-        'callback': None
+        'callback': None,
+        'app_icon': 'Defaults to package app icon'
     }
-    # 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):
+    def __init__(self,**kwargs): #pylint: disable=W0231 #@dataclass already does work
         self.__validateArgs(kwargs)
-        # Basic options
-        self.title=''
-        self.message=''
-        self.style=''
-        self.large_icon_path=''
-        self.big_picture_path=''
-        self.progress_current_value=0
-        self.progress_max_value=0
-        self.body= ''
-
-        # For Nofitication Functions
-        self.identifer=''
-        self.callback = None
-
-        # Advance Options
-        self.channel_name='Default Channel'
-        self.channel_id='default_channel'
-        self.silent=False
-
         # Private (Don't Touch)
         self.__id = self.__getUniqueID()
         self.__setArgs(kwargs)
@@ -178,7 +156,11 @@ class Notification:
             self.__builder.setContentText(String(self.message))
 
     def updateProgressBar(self,current_value,message:str=''):
-        """current_value is the value to set progressbar, message defaults to last message
+        """Updates progress bar current value
+        
+        Args:
+            current_value (str): the value from progressbar current progress
+            message (str): defaults to last message
         
         NOTE: There is a 0.5sec delay
         """
@@ -206,9 +188,13 @@ class Notification:
         self.__update_timer = threading.Timer(0.5, delayed_update)
         self.__update_timer.start()
         
-    def removeProgressBar(self,message=''):
-        """message defaults to last message"""
+    def removeProgressBar(self,message='',show_on_update=True) -> None:
+        """Removes Progress Bar from Notification
 
+        Args:
+            message (str, optional): notification message. Defaults to 'last message'.
+            show_on_update (bool, optional): To show notification brifely when progressbar removed. Defaults to True.
+        """
         if self.__update_timer:
             self.__update_timer.cancel()
             self.__update_timer = None
@@ -219,21 +205,24 @@ class Notification:
         if not ON_ANDROID:
             return False
 
+        self.__builder.setOnlyAlertOnce(not show_on_update)
         if message:
             self.__builder.setContentText(String(message))
         self.__builder.setProgress(0, 0, False)
         self.notification_manager.notify(self.__id, self.__builder.build())
         return True
 
-    def send(self,silent:bool=False):
+    def send(self,silent:bool=False,persistent=False,close_on_click=True):
         """Sends notification
         
         Args:
             silent (bool): True if you don't want to show briefly on screen
+            persistent (bool): True To not remove Notification When User hits clears All notifications button
+            close_on_click (bool): True if you want Notification to be removed when clicked
         """
         self.silent=self.silent or silent
         if ON_ANDROID:
-            self.__startNotificationBuild()
+            self.__startNotificationBuild(persistent,close_on_click)
             self.notification_manager.notify(self.__id, self.__builder.build())
         elif self.logs:
             string_to_display=''
@@ -296,6 +285,15 @@ class Notification:
         # Set content intent for notification tap
         self.__builder.setContentIntent(pending_action_intent)
 
+    def removeButtons(self):
+        """Removes all notification buttons
+        """
+        if ON_ANDROID:
+            self.__builder.mActions.clear()
+            self.notification_manager.notify(self.__id, self.__builder.build())
+        if self.logs:
+            print('Removed Notication Buttons')
+
     @run_on_ui_thread
     def addNotificationStyle(self,style:str,already_sent=False):
         """Adds Style to Notification
@@ -385,12 +383,12 @@ class Notification:
         if "channel_id" not in options_dict and 'channel_name' in options_dict: # if User doesn't input channel id but inputs channel_name
             setattr(self,'channel_id', self.__generate_channel_id(options_dict['channel_name']))
 
-    def __startNotificationBuild(self):
-        self.__createBasicNotification()
+    def __startNotificationBuild(self,persistent,close_on_click):
+        self.__createBasicNotification(persistent,close_on_click)
         if self.style not in ['simple','']:
             self.addNotificationStyle(self.style)
 
-    def __createBasicNotification(self):
+    def __createBasicNotification(self,persistent,close_on_click):
         # Notification Channel (Required for Android 8.0+)
         # print("THis is cchannel is ",self.channel_id) #"
         if BuildVersion.SDK_INT >= 26 and self.notification_manager.getNotificationChannel(self.channel_id) is None:
@@ -408,29 +406,58 @@ class Notification:
         # TODO fix this by creating a on_Title method in other versions
         self.__builder.setContentTitle(str(self.title))
         self.__builder.setContentText(str(self.message))
-        self.__builder.setSmallIcon(context.getApplicationInfo().icon)
+        self.__insertAppIcon()
         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.__builder.setOngoing(persistent)
+        self.__builder.setAutoCancel(close_on_click)
         self.__addIntentToOpenApp()
     
     # def __doCustomStyle(self):
     #     # TODO Will implement when needed
     #     return self.__builder
-
+    def __insertAppIcon(self):
+        if self.app_icon not in ['','Defaults to package app icon']:
+            self.__setIconFromBitmap(self.app_icon)
+        else:
+            self.__builder.setSmallIcon(context.getApplicationInfo().icon)
+        
     def __buildImg(self, user_img,img_style):
         if user_img.startswith('http://') or user_img.startswith('https://'):
+            def callback(bitmap):
+                self.__applyNotificationImage(bitmap,img_style)
             thread = threading.Thread(
-                                        target=self.__getImgFromURL,
-                                        args=(user_img,img_style,)
+                                        target=self.__getBitmapFromURL,
+                                        args=[user_img,callback]
                                     )
             thread.start()
         else:
             bitmap = self.__getImgFromPath(user_img)
             if bitmap:
                 self.__applyNotificationImage(bitmap,img_style)
-
-
+    
+    def __setIconFromBitmap(self,img_path):
+        """Path can be link or relative path"""
+        if img_path.startswith('http://') or img_path.startswith('https://'):
+            def callback(bitmap):
+                icon = IconCompat.createWithBitmap(bitmap)
+                self.__builder.setSmallIcon(icon)
+            threading.Thread(
+                                        target=self.__getBitmapFromURL,
+                                        args=[img_path,callback]
+                                    ).start()
+        else:
+            bitmap = self.__getImgFromPath(img_path)
+            if bitmap:
+                icon = IconCompat.createWithBitmap(bitmap)
+                self.__builder.setSmallIcon(icon)
+            else:
+                if self.logs:
+                    print('Failed getting img for custom notification icon defaulting to app icon')
+                self.__builder.setSmallIcon(context.getApplicationInfo().icon)
+                
+        
     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)
@@ -439,13 +466,20 @@ class Notification:
             print("These are the existing files in your app Folder:")
             print('['+', '.join(os.listdir(app_folder)) + ']')
             return None
+        # TODO test with a badly written Image and catch error
         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):
+    def __getBitmapFromURL(self,url,callback):
+        """Gets Bitmap from url
+
+        Args:
+            url (str): img url
+            callback (function): method to be called after thread done -passes in bitmap data as argument
+        """
         if self.logs:
-            print("getting image from URL---")
+            print("getting Bitmap from URL---")
         try:
             URL = autoclass('java.net.URL')
             url = URL(url)
@@ -454,11 +488,33 @@ class Notification:
             input_stream = connection.getInputStream()
             bitmap = BitmapFactory.decodeStream(input_stream)
             input_stream.close()
-            self.__applyNotificationImage(bitmap,img_style)
+            if bitmap:
+                callback(bitmap)
+            else:
+                print('Error No Bitmap ------------')
         except Exception as e:
-            # TODO get type of JAVA Error
+            # TODO get all types of JAVA Error
             print('Error Type ',e)
-            print('Failed to get Img from URL ',traceback.format_exc())
+            print('Failed to get Bitmap from URL ',traceback.format_exc())
+
+    # def __getImgFromURL(self,url,img_style):
+    #     if self.logs:
+    #         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()
+    #         if bitmap:
+    #             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):
@@ -526,8 +582,7 @@ class Notification:
                             intent, PendingIntent.FLAG_IMMUTABLE if BuildVersion.SDK_INT >= 31 else PendingIntent.FLAG_UPDATE_CURRENT
                         )
         self.__builder.setContentIntent(pending_intent)
-        self.__builder.setAutoCancel(True)
-
+        
     def __addDataToIntent(self,intent):
         """Persit Some data to notification object for later use"""
         bundle = Bundle()

{android_notify-1.52.5 → android_notify-1.53}/android_notify.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: android-notify
-Version: 1.52.5
+Version: 1.53
 Summary: A Python package that simpilfies creating Android notifications in Kivy apps.
 Home-page: https://github.com/fector101/android-notify
 Author: Fabian
@@ -49,6 +49,7 @@ Dynamic: summary
 - Supports including images in notifications.
 - All Notifications can take Functions (version 1.50+) [functions section](#functions).
 - Advanced Notification Handling [section](#advanced-features).
+- Changing default app notification icon with PNG,
 - Support for multiple notification styles:
   - [Simple](#basic-usage)
   - [Progress](#progress-bar-notification)
@@ -58,10 +59,13 @@ Dynamic: summary
   - [Buttons](#notification-with-buttons)
   - [Big Text](#big-text-notification)
 
+- persistenting notification [section](#methods)
+
 This module automatically handles:
 
 - Permission requests for notifications
 - Customizable notification channels.
+- Opening app on notification click
 
 ## Installation
 
@@ -128,6 +132,7 @@ The library supports multiple notification styles:
 #### Progress Bar notification
 
 ```python
+from kivy.clock import Clock
 
 progress = 0
 
@@ -207,6 +212,8 @@ notification.send()
 
 #### Notification with Buttons
 
+Here's a sample of how to add buttons below, To Remove Buttons Simply Call the `removeButtons` method on the Notification Instance
+
 ```python
 notification = Notification(title="Jane Dough", message="How to use android-notify #coding #purepython")
 def playVideo():
@@ -271,7 +278,8 @@ notification.send()
 notification.updateProgressBar(30, "30% downloaded")
 
 # Remove progress bar
-notification.removeProgressBar("Download Complete")
+# show_on_update to notification briefly after removed progressbar
+notification.removeProgressBar("Download Complete",show_on_update=True)
 ```
 
 ### Adding Style even when already sent
@@ -395,6 +403,63 @@ notification.send()
 # Will print notification properties instead of sending
 ```
 
+### Methods
+
+### Instance.**init**
+
+args
+
+- app_icon: To Change Default app icon use PNG Or Image Will display as a Black Box
+
+### Instance.send
+
+args
+
+- persistent : To make notification stay after user clicks clear All
+- close_on_click : To close notification on click
+
+### Instance.addButton
+
+args
+
+- text : Button Text
+
+### Instance.updateTitle
+
+args
+
+- new_title : String to be set as New notification Title
+
+### Instance.updateMessage
+
+args
+
+- new_message : String to be set as New notification Message
+
+### Instance.updateProgressBar
+
+args
+
+- current_value (str): the value from progressbar current progress
+- message (str,optional): defaults to last message
+
+### Instance.removeProgressBar
+
+This Removes Progress bar
+
+args
+
+- message (str, optional): notification message, Defaults to 'last message'.
+- show_on_update (bool, optional): To show notification brifely when progressbar removed. Defaults to True.
+
+### Instance.addNotificationStyle
+
+This is useful to add style after Notification is sent or Add more styles to Notification
+args
+
+- style: choosen style. All options are in the `NotificationStyles` class `['simple','progress','inbox','big_text','large_icon','big_picture','both_imgs]`
+- already_sent: specfiy if notification.send() method has already been called, it defaults to false
+
 ## Image Requirements
 
 - Online Images should start with `http://` or `https://`

{android_notify-1.52.5 → android_notify-1.53}/android_notify.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ setup.py
 android_notify/__init__.py
 android_notify/__main__.py
 android_notify/core.py
+android_notify/facade.py
 android_notify/styles.py
 android_notify/sword.py
 android_notify.egg-info/PKG-INFO

{android_notify-1.52.5 → android_notify-1.53}/setup.py

@@ -6,7 +6,7 @@ with open("README.md", "r", encoding="utf-8") as readme_data:
 
 setup(
     name="android-notify",
-    version="1.52.5",
+    version="1.53",
     author="Fabian",
     author_email='fector101@yahoo.com',
     description="A Python package that simpilfies creating Android notifications in Kivy apps.",