android-notify 1.1__tar.gz → 1.21__tar.gz

android_notify-1.21/PKG-INFO

@@ -0,0 +1,251 @@
+Metadata-Version: 2.1
+Name: android_notify
+Version: 1.21
+Summary: A Python package for sending Android notifications.
+Home-page: https://github.com/Fector101/android_notify/
+Author: Fabian
+Author-email: fabianjoseph063@gmail.com
+Project-URL: Funding, https://buymeacoffee.com/fector101
+Project-URL: Source, https://github.com/Fector101/android_notify/
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: pyjnius
+
+# 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
+
+# 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 module comes 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 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.21/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
+
+# 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 module comes 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 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.21/android_notify/__init__.py

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

android_notify-1.21/android_notify/core.py

@@ -0,0 +1,132 @@
+
+from jnius import autoclass,cast
+import random
+import os
+
+ON_ANDROID = False
+try:
+    # Get the required Java classes
+    PythonActivity = autoclass('org.kivy.android.PythonActivity')
+    NotificationChannel = autoclass('android.app.NotificationChannel')
+    String = autoclass('java.lang.String')
+    Intent = autoclass('android.content.Intent')
+    PendingIntent = autoclass('android.app.PendingIntent')
+    context = PythonActivity.mActivity # Get the app's context 
+    BitmapFactory = autoclass('android.graphics.BitmapFactory')
+    BuildVersion = autoclass('android.os.Build$VERSION')    
+    ON_ANDROID=True
+except Exception as e:
+    print('This Package Only Runs on Android !!! ---> Check "https://github.com/Fector101/android_notify/" to see design patterns and more info.')
+
+if ON_ANDROID:
+    try:
+        NotificationManagerCompat = autoclass('androidx.core.app.NotificationManagerCompat')                                       
+        NotificationCompat = autoclass('androidx.core.app.NotificationCompat')
+
+        # 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:
+        print("""
+        Dependency Error: Add the following in buildozer.spec:
+        * android.gradle_dependencies = androidx.core:core-ktx:1.15.0, androidx.core:core:1.6.0
+        * android.enable_androidx = True
+        * android.permissions = POST_NOTIFICATIONS
+        """)
+
+def asks_permission_if_needed():
+    """
+    Ask for permission to send notifications if needed.
+    """
+    from android.permissions import request_permissions, Permission,check_permission # type: ignore
+
+    permissions=[Permission.POST_NOTIFICATIONS]
+    if not all(check_permission(p) for p in permissions):
+        request_permissions(permissions)
+
+def get_image_uri(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').
+    """
+    from android.storage import app_storage_path # type: ignore
+
+    output_path = os.path.join(app_storage_path(),'app', relative_path)
+    # print(output_path,'output_path')  # /data/user/0/org.laner.lan_ft/files/app/assets/imgs/icon.png
+    
+    if not os.path.exists(output_path):
+        raise FileNotFoundError(f"Image not found at path: {output_path}")
+    
+    Uri = autoclass('android.net.Uri')
+    return Uri.parse(f"file://{output_path}")
+
+
+def send_notification(title:str, message:str, style=None, img_path=None, channel_id:str="default_channel"):
+    """
+    Send a notification on Android.
+
+    :param title: Title of the 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.
+    """
+    if not ON_ANDROID:
+        print('This Package Only Runs on Android !!! ---> Check "https://github.com/Fector101/android_notify/" for Documentation.')
+        return
+    
+    # Get notification manager
+    notification_manager = context.getSystemService(context.NOTIFICATION_SERVICE)
+
+    # importance= autoclass('android.app.NotificationManager').IMPORTANCE_HIGH # also works #NotificationManager.IMPORTANCE_DEFAULT
+    importance= NotificationManagerCompat.IMPORTANCE_HIGH #autoclass('android.app.NotificationManager').IMPORTANCE_HIGH also works #NotificationManager.IMPORTANCE_DEFAULT
+    
+    # Notification Channel (Required for Android 8.0+)
+    if BuildVersion.SDK_INT >= 26:
+        channel = NotificationChannel(channel_id, "Default Channel",importance)
+        notification_manager.createNotificationChannel(channel)
+
+    # Build the notification
+    builder = NotificationCompatBuilder(context, channel_id)
+    builder.setContentTitle(title)
+    builder.setContentText(message)
+    builder.setSmallIcon(context.getApplicationInfo().icon)
+    builder.setDefaults(NotificationCompat.DEFAULT_ALL) 
+    builder.setPriority(NotificationCompat.PRIORITY_HIGH)
+    
+    img=None
+    if img_path:
+        try:
+            img = get_image_uri(img_path)
+        except FileNotFoundError as e:
+            print('Failed Adding Bitmap: ',e)
+    
+    # Apply notification styles
+    try:
+        if style == "big_text":
+            big_text_style = NotificationCompatBigTextStyle()
+            big_text_style.bigText(message)
+            builder.setStyle(big_text_style)
+        elif style == "big_picture" and img_path:
+            bitmap = BitmapFactory.decodeStream(context.getContentResolver().openInputStream(img))
+            builder.setLargeIcon(bitmap)
+            big_picture_style = NotificationCompatBigPictureStyle().bigPicture(bitmap)
+            builder.setStyle(big_picture_style)
+        elif style == "inbox":
+            inbox_style = NotificationCompatInboxStyle()
+            for line in message.split("\n"):
+                inbox_style.addLine(line)
+            builder.setStyle(inbox_style)
+        elif style == "large_icon" and img_path:
+            bitmap = BitmapFactory.decodeStream(context.getContentResolver().openInputStream(img))
+            builder.setLargeIcon(bitmap)
+    except Exception as e:
+        print('Failed Adding Style: ',e)
+    # Display the notification
+    notification_id = random.randint(0, 100)
+    notification_manager.notify(notification_id, builder.build())
+    return notification_id