android-notify 1.3__tar.gz → 1.5__tar.gz

{android_notify-1.3 → android_notify-1.5}/PKG-INFO

@@ -1,7 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: android-notify
-Version: 1.3
-Summary: A Python package that simpilfies creating Android Post notifications using PyJNIus in Kivy apps.
+Version: 1.5
+Summary: A Python package that simpilfies creating Android notifications in Kivy apps.
 Home-page: https://github.com/fector101/android-notify
 Author: Fabian
 Author-email: fector101@yahoo.com
@@ -21,22 +21,41 @@ Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 Requires-Dist: kivy>=2.0.0
 Requires-Dist: pyjnius>=1.4.2
-
-# Android-Notifiy
-
-A Python library for effortlessly creating and managing Android notifications  in Kivy android apps.
-Supports various styles and ensures seamless integration and customization.
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+<div align="center">
+    <br>
+    <h1> Android-Notifiy </h1>
+    <p> A Python library for effortlessly creating and managing Android notifications in Kivy android apps.</p>
+    <p>Supports various styles and ensures seamless integration and customization.</p>
+    <!-- <br> -->
+    <!-- <img src="https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/democollage.jpg"> -->
+</div>
 
 ## Features
 
-- Compatible with Android 8.0+.
+- Also Compatible with Android 8.0+.
 - Supports including images in notifications.
+- All Notifications can take Functions (version 1.5+) [functions docs](#functions).
 - Support for multiple notification styles:
-  - Progress
-  - Big Picture
-  - Inbox
-  - Big Text
-  - Large Icon
+  - [Simple](#basic-usage)
+  - [Progress](#progress-bar-notification)
+  - [Big Picture](#notification-with-an-image-big-picture-style)
+  - [Inbox](#inbox-notification-style)
+  - [Large Icon](#notification-with-an-image-large-icon-style)
+  - [Buttons](#notification-with-buttons)
+  - [Big Text](#big-text-notification-will-display-as-simple-text-if-device-dosent-support)
 
 This module automatically handles:
 
@@ -60,7 +79,7 @@ pip install android-notify
 In your **`buildozer.spec`** file, ensure you include the following:
 
 ```ini
-# Add pyjnius so it's packaged with the build
+# Add pyjnius so ensure it's packaged with the build
 requirements = python3, kivy, pyjnius, android-notify
 
 # Add permission for notifications
@@ -81,7 +100,7 @@ from android_notify import Notification
 # Create a simple notification
 notification = Notification(
     title="Hello",
-    message="This is a basic notification"
+    message="This is a basic notification."
 )
 notification.send()
 ```
@@ -104,6 +123,25 @@ The library supports multiple notification styles:
 
 ### Style Examples
 
+#### Progress Bar notification
+
+```python
+from kivy.clock import Clock
+
+notification = Notification(
+    title="Downloading...",
+    message="0% downloaded",
+    style="progress",
+    progress_max_value=100,
+    progress_current_value=0
+)
+notification.send()
+Clock.schedule_once(lambda dt: notification.updateProgressBar(30, "30% downloaded"), 350)
+```
+
+**Sample Image:**
+![progress img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/progress.jpg)
+
 #### Notification with an Image (Big Picture Style)
 
 ```python
@@ -114,6 +152,8 @@ notification = Notification(
     style="big_picture",
     big_picture_path="assets/imgs/photo.png"
 )
+notification.send()
+
 ```
 
 **Sample Image:**
@@ -128,52 +168,60 @@ notification = Notification(
     message='Line 1\nLine 2\nLine 3',
     style='inbox'
 )
+notification.send()
+
 ```
 
 **Sample Image:**
 ![Inbox Notification sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/inboxnoti.jpg)
 
-#### Big text notification (Will Display as simple text if Device dosen't support)
+#### Notification with an Image (Large Icon Style)
 
 ```python
 notification = Notification(
-    title="Article",
-    message="Long article content...",
-    style="big_text"
+    title="FabianDev_",
+    message="A twitter about some programming stuff",
+    style="large_icon",
+    large_icon_path="assets/imgs/profile.png"
 )
+
 ```
 
-#### Progress bar notification
+**Sample Image:**  
+![large_icon img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/large_icon.jpg)
+
+#### Notification with Buttons
 
 ```python
-notification = Notification(
-    title="Download",
-    message="Downloading file...",
-    style="progress",
-    progress_max_value=100,
-    progress_current_value=0
-)
+notification = Notification(title="Jane Dough", message="How to use android-notify #coding #purepython")
+def playVideo():
+    print('Playing Video')
+
+def turnOffNoti():
+    print('Please Turn OFf Noti')
+
+def watchLater():
+    print('Add to Watch Later')
 
+notification.addButton(text="Play",on_release=playVideo)
+notification.addButton(text="Turn Off",on_release=turnOffNoti)
+notification.addButton(text="Watch Later",on_release=watchLater)
+notification.send()
 ```
 
-**Sample Image:**
-![progress img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/progress.jpg)
+**Sample Image:**  
+![btns img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/btns.jpg)
 
-#### Notification with an Image (Large Icon Style)
+#### Big text notification (Will Display as normal text if Device dosen't support)
 
 ```python
 notification = Notification(
-    title="Completed download",
-    message="profile.jpg",
-    style="large_icon",
-    large_icon_path="assets/imgs/profile.png"
+    title="Article",
+    message="Long article content...",
+    style="big_text"
 )
-
 ```
 
-**Sample Image:**  
-![large_icon img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/large_icon.jpg)
-
 ## Advanced Features
 
 ### Updating Notifications
@@ -193,12 +241,12 @@ notification.updateMessage("New Message")
 
 ```python
 notification = Notification(
-    title="Download Progress",
+    title="Download..",
     style="progress"
 )
 
 # Update progress
-notification.updateProgressBar(50, "50% Complete")
+notification.updateProgressBar(30, "30% downloaded")
 
 # Remove progress bar
 notification.removeProgressBar("Download Complete")
@@ -214,8 +262,8 @@ Notifications are organized into channels. You can customize the channel name an
 notification = Notification(
     title="Download finished",
     message="How to Catch a Fish.mp4",
-    channel_name="Download Notifications",  # Will create User-visible name "downloads"
-    channel_id="custom_downloads"  # Optional: specify custom channel ID
+    channel_name="Download Notifications",  # Will create User-visible name "Download Notifications"
+    channel_id="downloads_notifications"  # Optional: specify custom channel ID
 )
 ```
 
@@ -231,6 +279,60 @@ notification = Notification(title="Silent Update")
 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
+
+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):
+        print("print in Debug Console")
+```
+
+### Get Which Notification was used to Open App - identifer (str)
+
+If you just want to get the Exact Notification Clicked to Open App, you can use NotificationHandler to get unique identifer
+
+```python
+from kivymd.app import MDApp
+from android_notify import Notification, NotificationHandler
+
+class Myapp(MDApp):
+    
+    def on_start(self):
+        
+        notify = Notification(title="Change Page", message="Click to change App page.", identifer='change_app_page')
+        notify.send()
+
+        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()
+        if notify_identifer == 'change_app_page':
+            # Code to change Screen
+            pass
+        elif notify_identifer == 'change_app_color':
+            # Code to change Screen Color
+            pass
+```
+
+
+
 ### Assist
 
 - How to Copy image to app folder
@@ -249,7 +351,7 @@ shutil.copy(image_path, os.path.join(app_path, "profile.png"))
 
 ```python
 from android_notify import Notification, NotificationStyles
-notification = Notification(
+Notification(
     title="New Photo",
     message="Check out this image",
     style=NotificationStyles.BIG_PICTURE,
@@ -273,7 +375,7 @@ notification.send()
 
 ## Image Requirements
 
-- Images must be located within your app's asset folder
+- Images must be located within your app's folder
 - Supported paths are relative to your app's storage path
 - Example: `assets/imgs/icon.png`
 

{android_notify-1.3 → android_notify-1.5}/README.md

@@ -1,18 +1,25 @@
-# Android-Notifiy
-
-A Python library for effortlessly creating and managing Android notifications  in Kivy android apps.
-Supports various styles and ensures seamless integration and customization.
+<div align="center">
+    <br>
+    <h1> Android-Notifiy </h1>
+    <p> A Python library for effortlessly creating and managing Android notifications in Kivy android apps.</p>
+    <p>Supports various styles and ensures seamless integration and customization.</p>
+    <!-- <br> -->
+    <!-- <img src="https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/democollage.jpg"> -->
+</div>
 
 ## Features
 
-- Compatible with Android 8.0+.
+- Also Compatible with Android 8.0+.
 - Supports including images in notifications.
+- All Notifications can take Functions (version 1.5+) [functions docs](#functions).
 - Support for multiple notification styles:
-  - Progress
-  - Big Picture
-  - Inbox
-  - Big Text
-  - Large Icon
+  - [Simple](#basic-usage)
+  - [Progress](#progress-bar-notification)
+  - [Big Picture](#notification-with-an-image-big-picture-style)
+  - [Inbox](#inbox-notification-style)
+  - [Large Icon](#notification-with-an-image-large-icon-style)
+  - [Buttons](#notification-with-buttons)
+  - [Big Text](#big-text-notification-will-display-as-simple-text-if-device-dosent-support)
 
 This module automatically handles:
 
@@ -36,7 +43,7 @@ pip install android-notify
 In your **`buildozer.spec`** file, ensure you include the following:
 
 ```ini
-# Add pyjnius so it's packaged with the build
+# Add pyjnius so ensure it's packaged with the build
 requirements = python3, kivy, pyjnius, android-notify
 
 # Add permission for notifications
@@ -57,7 +64,7 @@ from android_notify import Notification
 # Create a simple notification
 notification = Notification(
     title="Hello",
-    message="This is a basic notification"
+    message="This is a basic notification."
 )
 notification.send()
 ```
@@ -80,6 +87,25 @@ The library supports multiple notification styles:
 
 ### Style Examples
 
+#### Progress Bar notification
+
+```python
+from kivy.clock import Clock
+
+notification = Notification(
+    title="Downloading...",
+    message="0% downloaded",
+    style="progress",
+    progress_max_value=100,
+    progress_current_value=0
+)
+notification.send()
+Clock.schedule_once(lambda dt: notification.updateProgressBar(30, "30% downloaded"), 350)
+```
+
+**Sample Image:**
+![progress img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/progress.jpg)
+
 #### Notification with an Image (Big Picture Style)
 
 ```python
@@ -90,6 +116,8 @@ notification = Notification(
     style="big_picture",
     big_picture_path="assets/imgs/photo.png"
 )
+notification.send()
+
 ```
 
 **Sample Image:**
@@ -104,52 +132,60 @@ notification = Notification(
     message='Line 1\nLine 2\nLine 3',
     style='inbox'
 )
+notification.send()
+
 ```
 
 **Sample Image:**
 ![Inbox Notification sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/inboxnoti.jpg)
 
-#### Big text notification (Will Display as simple text if Device dosen't support)
+#### Notification with an Image (Large Icon Style)
 
 ```python
 notification = Notification(
-    title="Article",
-    message="Long article content...",
-    style="big_text"
+    title="FabianDev_",
+    message="A twitter about some programming stuff",
+    style="large_icon",
+    large_icon_path="assets/imgs/profile.png"
 )
+
 ```
 
-#### Progress bar notification
+**Sample Image:**  
+![large_icon img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/large_icon.jpg)
+
+#### Notification with Buttons
 
 ```python
-notification = Notification(
-    title="Download",
-    message="Downloading file...",
-    style="progress",
-    progress_max_value=100,
-    progress_current_value=0
-)
+notification = Notification(title="Jane Dough", message="How to use android-notify #coding #purepython")
+def playVideo():
+    print('Playing Video')
 
+def turnOffNoti():
+    print('Please Turn OFf Noti')
+
+def watchLater():
+    print('Add to Watch Later')
+
+notification.addButton(text="Play",on_release=playVideo)
+notification.addButton(text="Turn Off",on_release=turnOffNoti)
+notification.addButton(text="Watch Later",on_release=watchLater)
+notification.send()
 ```
 
-**Sample Image:**
-![progress img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/progress.jpg)
+**Sample Image:**  
+![btns img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/btns.jpg)
 
-#### Notification with an Image (Large Icon Style)
+#### Big text notification (Will Display as normal text if Device dosen't support)
 
 ```python
 notification = Notification(
-    title="Completed download",
-    message="profile.jpg",
-    style="large_icon",
-    large_icon_path="assets/imgs/profile.png"
+    title="Article",
+    message="Long article content...",
+    style="big_text"
 )
-
 ```
 
-**Sample Image:**  
-![large_icon img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/large_icon.jpg)
-
 ## Advanced Features
 
 ### Updating Notifications
@@ -169,12 +205,12 @@ notification.updateMessage("New Message")
 
 ```python
 notification = Notification(
-    title="Download Progress",
+    title="Download..",
     style="progress"
 )
 
 # Update progress
-notification.updateProgressBar(50, "50% Complete")
+notification.updateProgressBar(30, "30% downloaded")
 
 # Remove progress bar
 notification.removeProgressBar("Download Complete")
@@ -190,8 +226,8 @@ Notifications are organized into channels. You can customize the channel name an
 notification = Notification(
     title="Download finished",
     message="How to Catch a Fish.mp4",
-    channel_name="Download Notifications",  # Will create User-visible name "downloads"
-    channel_id="custom_downloads"  # Optional: specify custom channel ID
+    channel_name="Download Notifications",  # Will create User-visible name "Download Notifications"
+    channel_id="downloads_notifications"  # Optional: specify custom channel ID
 )
 ```
 
@@ -207,6 +243,60 @@ notification = Notification(title="Silent Update")
 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
+
+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):
+        print("print in Debug Console")
+```
+
+### Get Which Notification was used to Open App - identifer (str)
+
+If you just want to get the Exact Notification Clicked to Open App, you can use NotificationHandler to get unique identifer
+
+```python
+from kivymd.app import MDApp
+from android_notify import Notification, NotificationHandler
+
+class Myapp(MDApp):
+    
+    def on_start(self):
+        
+        notify = Notification(title="Change Page", message="Click to change App page.", identifer='change_app_page')
+        notify.send()
+
+        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()
+        if notify_identifer == 'change_app_page':
+            # Code to change Screen
+            pass
+        elif notify_identifer == 'change_app_color':
+            # Code to change Screen Color
+            pass
+```
+
+
+
 ### Assist
 
 - How to Copy image to app folder
@@ -225,7 +315,7 @@ shutil.copy(image_path, os.path.join(app_path, "profile.png"))
 
 ```python
 from android_notify import Notification, NotificationStyles
-notification = Notification(
+Notification(
     title="New Photo",
     message="Check out this image",
     style=NotificationStyles.BIG_PICTURE,
@@ -249,7 +339,7 @@ notification.send()
 
 ## Image Requirements
 
-- Images must be located within your app's asset folder
+- Images must be located within your app's folder
 - Supported paths are relative to your app's storage path
 - Example: `assets/imgs/icon.png`
 

android_notify-1.5/android_notify/__init__.py

@@ -0,0 +1,4 @@
+""""For Easier Imports For Public Classes"""
+from .core import send_notification
+from .styles import NotificationStyles
+from .sword import Notification,NotificationHandler

{android_notify-1.3 → android_notify-1.5}/android_notify/core.py

@@ -1,10 +1,10 @@
 """ Non-Advanced Stuff """
 import random
 import os
-from jnius import autoclass,cast
 
 ON_ANDROID = False
 try:
+    from jnius import autoclass,cast # Needs Java to be installed
     # Get the required Java classes
     PythonActivity = autoclass('org.kivy.android.PythonActivity')
     NotificationChannel = autoclass('android.app.NotificationChannel')