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

android_notify-1.23/MANIFEST.in

@@ -0,0 +1 @@
+global-exclude *.env

android_notify-1.23/PKG-INFO

@@ -0,0 +1,262 @@
+Metadata-Version: 2.1
+Name: android-notify
+Version: 1.23
+Summary: A Python package for sending Android notifications using PyJNIus in Kivy apps.
+Home-page: https://github.com/fector101/android-notify
+Author: Fabian
+Author-email: fector101@yahoo.com
+License: MIT
+Project-URL: Documentation, https://github.com/fector101/android-notify/
+Project-URL: Source, https://github.com/fector101/android-notify
+Project-URL: Tracker, https://github.com/fector101/android-notify/issues
+Project-URL: Funding, https://www.buymeacoffee.com/fector101
+Keywords: android,notifications,kivy,mobile,push notifications,pyjnius,android notifications,kivy notifications,python android,mobile development
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Android
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: kivy>=2.0.0
+Requires-Dist: pyjnius>=1.4.2
+
+# Android Notify
+
+`android_notify` is a Python module designed to simplify sending Android notifications using Kivy and Pyjnius. It supports multiple notification styles, including text, images, and inbox layouts.
+
+## Features
+
+- Send Android notifications with custom titles and messages.
+- Support for multiple notification styles:
+  - Big Text
+  - Big Picture
+  - Large Icon
+  - Inbox
+- Supports including images in notifications.
+- Compatible with Android 8.0+ (Notification Channels).
+- Customizable notification channels.
+
+## Installation
+
+This package is available on PyPI and can be installed via pip:
+
+```bash
+pip install android-notify
+```
+
+## **Dependencies**
+
+**Prerequisites:**  
+
+- Buildozer  
+- Kivy
+
+In your **`buildozer.spec`** file, ensure you include the following:
+
+```ini
+# Add pyjnius so it's packaged with the build
+requirements = python3, kivy, pyjnius, android-notify
+
+# Add permission for notifications
+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
+```
+
+---
+
+### Example Notification
+
+#### Basic Notification
+
+```python
+from android_notify import send_notification
+
+# Send a basic notification
+send_notification("Hello", "This is a basic notification.")
+```
+
+**Example Image:**  
+![Basic Notification](path/to/basic-notification-image.png)
+
+#### Notification with an Image (Big Picture Style)
+
+```python
+# Send a notification with an image
+send_notification(
+    title='Picture Alert!',
+    message='This notification includes an image.',
+    style='big_picture',
+    img_path='assets/imgs/icon.png'
+)
+```
+
+**Example Image:**  
+![Big Picture Notification](path/to/big-picture-notification-image.png)
+
+#### Inbox Notification Style
+
+```python
+# Send a notification with inbox style
+send_notification(
+    title='Inbox Notification',
+    message='Line 1\nLine 2\nLine 3',
+    style='inbox'
+)
+```
+
+**Example Image:**  
+![Inbox Notification](path/to/inbox-notification-image.png)
+
+#### Big Text Notification
+
+```python
+# Send a Big Text notification
+send_notification(
+    title='Hello!',
+    message='This is a sample notification.',
+    style='big_text'
+)
+```
+
+**Example Image:**  
+![Big Text Notification](path/to/big-text-notification-image.png)
+
+---
+
+### **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
+from android_notify import send_notification, NotificationStyles
+send_notification(
+    title='Picture Alert!',
+    message='This notification includes an image.',
+    img_path='assets/imgs/icon.png'
+    style=NotificationStyles.BIG_PICTURE,
+)
+```
+
+---
+
+### **Functions Reference**
+
+### 1. `asks_permission_if_needed()`
+
+**Description:**
+
+- Checks if notification permissions are granted and requests them if missing.
+
+**Usage:**
+
+```python
+asks_permission_if_needed()
+```
+
+---
+
+### 2. `get_image_uri(relative_path)`
+
+**Description:**
+
+- Resolves the absolute URI for an image in the app's storage.
+
+**Parameters:**
+
+- `relative_path` *(str)*: Path to the image (e.g., `assets/imgs/icon.png`).
+
+**Returns:**
+
+- `Uri`: Android URI object for the image.
+
+**Usage:**
+
+```python
+uri = get_image_uri('assets/imgs/icon.png')
+```
+
+---
+
+### 3. `send_notification(title, message, style=None, img_path=None, channel_id='default_channel')`
+
+**Description:**
+
+- Sends an Android notification with optional styles and images.
+
+**Parameters:**
+
+- `title` *(str)*: Notification title.
+- `message` *(str)*: Notification message.
+- `style` *(str, optional)*: Notification style (`big_text`, `big_picture`, `inbox`, `large_icon`).
+- `img_path` *(str, optional)*: Path to the image resource.(for `big_picture` or `large_icon` styles).
+- `channel_id` *(str, optional)*: Notification channel ID.
+
+Returns - notification id
+
+### Advanced Usage
+
+You can customize notification channels for different types of notifications.
+
+```python
+send_notification(
+    title='Custom Channel Notification',
+    message='This uses a custom notification channel.',
+    channel_id='custom_channel'
+)
+```
+
+## Contribution
+
+Feel free to open issues or submit pull requests for improvements!
+
+## 🐛 Reporting Issues
+
+Found a bug? Please open an issue on our [GitHub Issues](https://github.com/Fector101/android_notify/issues) page.
+
+## Author
+
+- Fabian - <fector101@yahoo.com>
+- GitHub: <https://github.com/Fector101/android_notify>
+- Twitter: <https://x.com/CodewithFabian> -- 😊 I'm sure to answer
+
+For feedback or contributions, feel free to reach out!
+
+---
+
+## ☕ Support the Project
+
+If you find this project helpful, consider buying me a coffee! Your support helps maintain and improve the project.
+
+<a href="https://www.buymeacoffee.com/fector101" target="_blank">
+  <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="60">
+</a>
+
+---
+
+## Acknowledgments
+
+- Thanks to the Kivy and Pyjnius communities for their support.
+
+---
+
+## 🌐 **Links**
+
+- **PyPI:** [android-notify on PyPI](https://pypi.org/project/android-notify/)
+- **GitHub:** [Source Code Repository](https://github.com/Fector101/android_notify/)

android_notify-1.23/README.md

@@ -0,0 +1,238 @@
+# Android Notify
+
+`android_notify` is a Python module designed to simplify sending Android notifications using Kivy and Pyjnius. It supports multiple notification styles, including text, images, and inbox layouts.
+
+## Features
+
+- Send Android notifications with custom titles and messages.
+- Support for multiple notification styles:
+  - Big Text
+  - Big Picture
+  - Large Icon
+  - Inbox
+- Supports including images in notifications.
+- Compatible with Android 8.0+ (Notification Channels).
+- Customizable notification channels.
+
+## Installation
+
+This package is available on PyPI and can be installed via pip:
+
+```bash
+pip install android-notify
+```
+
+## **Dependencies**
+
+**Prerequisites:**  
+
+- Buildozer  
+- Kivy
+
+In your **`buildozer.spec`** file, ensure you include the following:
+
+```ini
+# Add pyjnius so it's packaged with the build
+requirements = python3, kivy, pyjnius, android-notify
+
+# Add permission for notifications
+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
+```
+
+---
+
+### Example Notification
+
+#### Basic Notification
+
+```python
+from android_notify import send_notification
+
+# Send a basic notification
+send_notification("Hello", "This is a basic notification.")
+```
+
+**Example Image:**  
+![Basic Notification](path/to/basic-notification-image.png)
+
+#### Notification with an Image (Big Picture Style)
+
+```python
+# Send a notification with an image
+send_notification(
+    title='Picture Alert!',
+    message='This notification includes an image.',
+    style='big_picture',
+    img_path='assets/imgs/icon.png'
+)
+```
+
+**Example Image:**  
+![Big Picture Notification](path/to/big-picture-notification-image.png)
+
+#### Inbox Notification Style
+
+```python
+# Send a notification with inbox style
+send_notification(
+    title='Inbox Notification',
+    message='Line 1\nLine 2\nLine 3',
+    style='inbox'
+)
+```
+
+**Example Image:**  
+![Inbox Notification](path/to/inbox-notification-image.png)
+
+#### Big Text Notification
+
+```python
+# Send a Big Text notification
+send_notification(
+    title='Hello!',
+    message='This is a sample notification.',
+    style='big_text'
+)
+```
+
+**Example Image:**  
+![Big Text Notification](path/to/big-text-notification-image.png)
+
+---
+
+### **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
+from android_notify import send_notification, NotificationStyles
+send_notification(
+    title='Picture Alert!',
+    message='This notification includes an image.',
+    img_path='assets/imgs/icon.png'
+    style=NotificationStyles.BIG_PICTURE,
+)
+```
+
+---
+
+### **Functions Reference**
+
+### 1. `asks_permission_if_needed()`
+
+**Description:**
+
+- Checks if notification permissions are granted and requests them if missing.
+
+**Usage:**
+
+```python
+asks_permission_if_needed()
+```
+
+---
+
+### 2. `get_image_uri(relative_path)`
+
+**Description:**
+
+- Resolves the absolute URI for an image in the app's storage.
+
+**Parameters:**
+
+- `relative_path` *(str)*: Path to the image (e.g., `assets/imgs/icon.png`).
+
+**Returns:**
+
+- `Uri`: Android URI object for the image.
+
+**Usage:**
+
+```python
+uri = get_image_uri('assets/imgs/icon.png')
+```
+
+---
+
+### 3. `send_notification(title, message, style=None, img_path=None, channel_id='default_channel')`
+
+**Description:**
+
+- Sends an Android notification with optional styles and images.
+
+**Parameters:**
+
+- `title` *(str)*: Notification title.
+- `message` *(str)*: Notification message.
+- `style` *(str, optional)*: Notification style (`big_text`, `big_picture`, `inbox`, `large_icon`).
+- `img_path` *(str, optional)*: Path to the image resource.(for `big_picture` or `large_icon` styles).
+- `channel_id` *(str, optional)*: Notification channel ID.
+
+Returns - notification id
+
+### Advanced Usage
+
+You can customize notification channels for different types of notifications.
+
+```python
+send_notification(
+    title='Custom Channel Notification',
+    message='This uses a custom notification channel.',
+    channel_id='custom_channel'
+)
+```
+
+## Contribution
+
+Feel free to open issues or submit pull requests for improvements!
+
+## 🐛 Reporting Issues
+
+Found a bug? Please open an issue on our [GitHub Issues](https://github.com/Fector101/android_notify/issues) page.
+
+## Author
+
+- Fabian - <fector101@yahoo.com>
+- GitHub: <https://github.com/Fector101/android_notify>
+- Twitter: <https://x.com/CodewithFabian> -- 😊 I'm sure to answer
+
+For feedback or contributions, feel free to reach out!
+
+---
+
+## ☕ Support the Project
+
+If you find this project helpful, consider buying me a coffee! Your support helps maintain and improve the project.
+
+<a href="https://www.buymeacoffee.com/fector101" target="_blank">
+  <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="60">
+</a>
+
+---
+
+## Acknowledgments
+
+- Thanks to the Kivy and Pyjnius communities for their support.
+
+---
+
+## 🌐 **Links**
+
+- **PyPI:** [android-notify on PyPI](https://pypi.org/project/android-notify/)
+- **GitHub:** [Source Code Repository](https://github.com/Fector101/android_notify/)

android_notify-1.23/android_notify/__init__.py

@@ -0,0 +1,2 @@
+from .core import send_notification
+from .styles import NotificationStyles

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

@@ -1,7 +1,7 @@
-""" Non-Advanced Stuff """
+
+from jnius import autoclass,cast
 import random
 import os
-from jnius import autoclass,cast
 
 ON_ANDROID = False
 try:
@@ -26,6 +26,7 @@ if ON_ANDROID:
         # Notification Design
         NotificationCompatBuilder = autoclass('androidx.core.app.NotificationCompat$Builder')
         NotificationCompatBigTextStyle = autoclass('androidx.core.app.NotificationCompat$BigTextStyle')
+        # NotificationCompatBigTextStyle = autoclass('android.app.Notification$BigTextStyle')
         NotificationCompatBigPictureStyle = autoclass('androidx.core.app.NotificationCompat$BigPictureStyle')
         NotificationCompatInboxStyle = autoclass('androidx.core.app.NotificationCompat$InboxStyle')
     except Exception as e:
@@ -64,14 +65,7 @@ def get_image_uri(relative_path):
     return Uri.parse(f"file://{output_path}")
 
 
-def send_notification(
-    title:str,
-    message:str,
-    style=None,
-    img_path=None,
-    channel_name="Default Channel",
-    channel_id:str="default_channel"
-    ):
+def send_notification(title:str, message:str, style=None, img_path=None, channel_id:str="default_channel"):
     """
     Send a notification on Android.
 
@@ -79,13 +73,13 @@ def send_notification(
     :param message: Message body.
     :param style: Style of the notification ('big_text', 'big_picture', 'inbox', 'large_icon').
     :param img_path: Path to the image resource.
-    :param channel_id: Notification channel ID.(Default is lowercase channel name arg in lowercase)
+    :param channel_id: Notification channel ID.
     """
     if not ON_ANDROID:
         print('This Package Only Runs on Android !!! ---> Check "https://github.com/Fector101/android_notify/" for Documentation.')
         return
     asks_permission_if_needed()
-    channel_id=channel_name.replace(' ','_').lower().lower() if not channel_id else channel_id
+    
     # Get notification manager
     notification_manager = context.getSystemService(context.NOTIFICATION_SERVICE)
 
@@ -94,7 +88,7 @@ def send_notification(
     
     # Notification Channel (Required for Android 8.0+)
     if BuildVersion.SDK_INT >= 26:
-        channel = NotificationChannel(channel_id, channel_name,importance)
+        channel = NotificationChannel(channel_id, "Default Channel",importance)
         notification_manager.createNotificationChannel(channel)
 
     # Build the notification
@@ -136,5 +130,4 @@ def send_notification(
     # Display the notification
     notification_id = random.randint(0, 100)
     notification_manager.notify(notification_id, builder.build())
-    return notification_id
-
+    return notification_id

android_notify-1.23/android_notify/styles.py

@@ -0,0 +1,5 @@
+class NotificationStyles:
+    BIG_TEXT = "big_text"
+    BIG_PICTURE = "big_picture"
+    INBOX = "inbox"
+    LARGE_ICON = "large_icon"