android-notify 0.2__tar.gz → 1.0__tar.gz

android_notify-1.0/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.1
+Name: android_notify
+Version: 1.0
+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
+
+# 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
+  - Inbox
+- Ability to include images in notifications.
+- Compatible with Android 8.0+ (Notification Channels).
+- Customizable notification channels.
+- Support for large icons in notifications.
+
+## Installation
+
+Make sure you have the required dependencies installed:
+
+```bash
+pip install android-notify
+```
+
+## Usage
+
+**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
+android.enable_androidx = True
+```
+
+### Example Notification
+
+```python
+from android_notify.core import send_notification
+
+# Send a basic notification
+send_notification("Hello", "This is a basic notification.")
+
+# 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'
+)
+
+# Send a notification with inbox style
+send_notification(
+    title='Inbox Notification',
+    message='Line 1\nLine 2\nLine 3',
+    style='inbox'
+)
+
+# Send a Big Text notification (Note this send as a normal notification if not supported on said device)
+send_notification(
+    title='Hello!',
+    message='This is a sample notification.',
+    style='big_text'
+)
+```
+
+### Function Reference
+
+#### `send_notification`
+
+- **title** (*str*): Notification title.
+- **message** (*str*): Notification message body.
+- **style** (*str*): Notification style (`big_text`, `big_picture`, `inbox`, `large_icon`).
+- **img_path** (*str*): Path to the image (for `big_picture` or `large_icon` styles).
+- **channel_id** (*str*): Notification channel ID.
+
+#### `get_image_uri`
+
+- Resolves the absolute URI of an image resource.
+- **relative_path** (*str*): The relative path to the image.
+
+### 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.
+
+## ☕ Support the Project
+
+If you find TurboTask 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>
+
+## Author
+
+- Fabian - <fector101@yahoo.com>
+- GitHub: <https://github.com/Fector101/android_notify>
+
+## Acknowledgments
+
+- Thanks to the Kivy and Pyjnius communities for their support.

android_notify-1.0/README.md

@@ -0,0 +1,127 @@
+# 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
+  - Inbox
+- Ability to include images in notifications.
+- Compatible with Android 8.0+ (Notification Channels).
+- Customizable notification channels.
+- Support for large icons in notifications.
+
+## Installation
+
+Make sure you have the required dependencies installed:
+
+```bash
+pip install android-notify
+```
+
+## Usage
+
+**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
+android.enable_androidx = True
+```
+
+### Example Notification
+
+```python
+from android_notify.core import send_notification
+
+# Send a basic notification
+send_notification("Hello", "This is a basic notification.")
+
+# 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'
+)
+
+# Send a notification with inbox style
+send_notification(
+    title='Inbox Notification',
+    message='Line 1\nLine 2\nLine 3',
+    style='inbox'
+)
+
+# Send a Big Text notification (Note this send as a normal notification if not supported on said device)
+send_notification(
+    title='Hello!',
+    message='This is a sample notification.',
+    style='big_text'
+)
+```
+
+### Function Reference
+
+#### `send_notification`
+
+- **title** (*str*): Notification title.
+- **message** (*str*): Notification message body.
+- **style** (*str*): Notification style (`big_text`, `big_picture`, `inbox`, `large_icon`).
+- **img_path** (*str*): Path to the image (for `big_picture` or `large_icon` styles).
+- **channel_id** (*str*): Notification channel ID.
+
+#### `get_image_uri`
+
+- Resolves the absolute URI of an image resource.
+- **relative_path** (*str*): The relative path to the image.
+
+### 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.
+
+## ☕ Support the Project
+
+If you find TurboTask 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>
+
+## Author
+
+- Fabian - <fector101@yahoo.com>
+- GitHub: <https://github.com/Fector101/android_notify>
+
+## Acknowledgments
+
+- Thanks to the Kivy and Pyjnius communities for their support.

android_notify-1.0/android_notify/core.py

@@ -0,0 +1,168 @@
+
+from jnius import autoclass,cast
+import random
+import os
+
+
+def asks_permission_if_needed():
+    """
+    Ask for permission to send notifications if needed.
+    """
+    # Get the required Java classes
+    from android.permissions import request_permissions, Permission,check_permission # type: ignore
+    
+    def check_permissions(permissions):
+        for permission in permissions:
+            if check_permission(permission) != True:
+                return False
+        return True
+
+    permissions=[Permission.POST_NOTIFICATIONS]
+    if check_permissions(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
+    # print("app_storage_path()",app_storage_path())
+
+    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
+
+    Uri = autoclass('android.net.Uri')
+    return Uri.parse(f"file://{output_path}")
+
+def send_notification(title, message, style=None, img_path=None, channel_id="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').
+    :param image: Image URL or drawable for 'big_picture' style.
+    :param channel_id: Notification channel ID.
+    """
+    # TODO check if running on android short circuit and return message if not
+    
+    # Get the required Java classes
+    # Notification Base
+    PythonActivity = autoclass('org.kivy.android.PythonActivity')
+    NotificationChannel = autoclass('android.app.NotificationChannel')
+    String = autoclass('java.lang.String')
+    
+    
+    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')
+    BitmapFactory = autoclass('android.graphics.BitmapFactory')
+    BuildVersion = autoclass('android.os.Build$VERSION')
+    PendingIntent = autoclass('android.app.PendingIntent')
+    Intent = autoclass('android.content.Intent')
+    
+    # Get the app's context and notification manager
+    context = PythonActivity.mActivity
+    notification_manager = context.getSystemService(context.NOTIFICATION_SERVICE)
+
+    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:
+        print('entered....')
+        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)
+    
+    # Get Image
+    img=img_path
+    if img_path:
+        try:
+            img = get_image_uri(img_path)
+        except Exception as e:
+            print('Failed getting Image path',e)
+    
+     # Add Actions (Buttons)
+    
+    # add Action 1 Button
+    # try:
+    #     # Create Action 1
+    #     action_intent = Intent(context, PythonActivity)
+    #     action_intent.setAction("ACTION_ONE")
+    #     pending_action_intent = PendingIntent.getActivity(
+    #         context, 
+    #         0, 
+    #         action_intent, 
+    #         PendingIntent.FLAG_IMMUTABLE
+    #     )
+        
+    #     # Convert text to CharSequence
+    #     action_text = cast('java.lang.CharSequence', String("Action 1"))
+        
+    #     # Add action with proper types
+    #     builder.addAction(
+    #         int(context.getApplicationInfo().icon),  # Cast icon to int
+    #         action_text,                             # CharSequence text
+    #         pending_action_intent                    # PendingIntent
+    #     )
+        
+        
+    #     # Set content intent for notification tap
+    #     builder.setContentIntent(pending_action_intent)
+    # except Exception as e:
+    #     print('Failed adding Action 1',e)
+
+    
+    # Apply styles
+    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:
+        try:
+            bitmap = BitmapFactory.decodeStream(context.getContentResolver().openInputStream(img))
+            # bitmap = BitmapFactory.decodeFile(img_path)
+            builder.setLargeIcon(bitmap)
+            big_picture_style = NotificationCompatBigPictureStyle().bigPicture(bitmap)
+            # big_picture_style.bigPicture(bitmap).bigLargeIcon(None)
+            # big_picture_style.bigLargeIcon(bitmap) # This just changes dropdown app icon
+            
+            builder.setStyle(big_picture_style)
+        except Exception as e:
+            print('Failed Adding Bitmap...', e)
+    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:
+        try:
+            bitmap = BitmapFactory.decodeStream(context.getContentResolver().openInputStream(img))
+            builder.setLargeIcon(bitmap)
+        except Exception as e:
+            print('Failed Large Icon...', e)
+    
+    # Show the notification
+    notification_manager.notify(random.randint(0, 100), builder.build())

{android_notify-0.2 → android_notify-1.0}/android_notify/styles.py

@@ -2,3 +2,4 @@ class NotificationStyles:
     BIG_TEXT = "big_text"
     BIG_PICTURE = "big_picture"
     INBOX = "inbox"
+    LARGE_ICON = "large_icon"

android_notify-1.0/android_notify.egg-info/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.1
+Name: android-notify
+Version: 1.0
+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
+
+# 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
+  - Inbox
+- Ability to include images in notifications.
+- Compatible with Android 8.0+ (Notification Channels).
+- Customizable notification channels.
+- Support for large icons in notifications.
+
+## Installation
+
+Make sure you have the required dependencies installed:
+
+```bash
+pip install android-notify
+```
+
+## Usage
+
+**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
+android.enable_androidx = True
+```
+
+### Example Notification
+
+```python
+from android_notify.core import send_notification
+
+# Send a basic notification
+send_notification("Hello", "This is a basic notification.")
+
+# 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'
+)
+
+# Send a notification with inbox style
+send_notification(
+    title='Inbox Notification',
+    message='Line 1\nLine 2\nLine 3',
+    style='inbox'
+)
+
+# Send a Big Text notification (Note this send as a normal notification if not supported on said device)
+send_notification(
+    title='Hello!',
+    message='This is a sample notification.',
+    style='big_text'
+)
+```
+
+### Function Reference
+
+#### `send_notification`
+
+- **title** (*str*): Notification title.
+- **message** (*str*): Notification message body.
+- **style** (*str*): Notification style (`big_text`, `big_picture`, `inbox`, `large_icon`).
+- **img_path** (*str*): Path to the image (for `big_picture` or `large_icon` styles).
+- **channel_id** (*str*): Notification channel ID.
+
+#### `get_image_uri`
+
+- Resolves the absolute URI of an image resource.
+- **relative_path** (*str*): The relative path to the image.
+
+### 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.
+
+## ☕ Support the Project
+
+If you find TurboTask 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>
+
+## Author
+
+- Fabian - <fector101@yahoo.com>
+- GitHub: <https://github.com/Fector101/android_notify>
+
+## Acknowledgments
+
+- Thanks to the Kivy and Pyjnius communities for their support.

android_notify-1.0/setup.py

@@ -0,0 +1,19 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='android_notify',
+    version='1.0',
+    author='Fabian',
+    url='https://github.com/Fector101/android_notify/',
+    description='A Python package for sending Android notifications.',
+    packages=find_packages(),
+    install_requires=['pyjnius'],
+    author_email='fabianjoseph063@gmail.com',
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    python_requires='>=3.6',
+    project_urls={
+        'Funding': 'https://buymeacoffee.com/fector101',
+        'Source': 'https://github.com/Fector101/android_notify/',
+    },
+)

android_notify-0.2/PKG-INFO

@@ -1,4 +0,0 @@
-Metadata-Version: 2.1
-Name: android_notify
-Version: 0.2
-Summary: A Python package for sending Android notifications.

android_notify-0.2/README.md

@@ -1,26 +0,0 @@
-# Usage
-
-```python
-from android_notify.core import send_notification
-from android_notify.styles import NotificationStyles
-
-# Send a basic notification
-send_notification("Hello", "This is a basic notification.")
-
-# Send a big text notification
-send_notification("Big Text", "This is a notification with a lot of text to show.", style=NotificationStyles.BIG_TEXT)
-
-# Send a big picture notification
-from jnius import autoclass
-Uri = autoclass('android.net.Uri')
-image_uri = Uri.parse("file:///path/to/image.jpg")
-send_notification("Big Picture", "Here's a notification with a picture.", style=NotificationStyles.BIG_PICTURE, image=image_uri)
-
-# Send an inbox style notification
-send_notification(
-    "Inbox Style",
-    "Line 1\nLine 2\nLine 3\nLine 4",
-    style=NotificationStyles.INBOX
-)
-
-```

android_notify-0.2/android_notify/core.py

@@ -1,100 +0,0 @@
-from jnius import autoclass
-import random
-from jnius import autoclass
-import os
-import shutil
-
-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 (e.g., 'file:///path/to/file.png').
-    """
-    # Access Android's context and asset manager
-    PythonActivity = autoclass('org.kivy.android.PythonActivity')
-    context = PythonActivity.mActivity
-    asset_manager = context.getAssets()
-
-    # Construct the full path for the output file in cache directory
-    cache_dir = context.getCacheDir().getAbsolutePath()
-    file_name = os.path.basename(relative_path)
-    output_path = os.path.join(cache_dir, file_name)
-
-    # Copy the file from assets to cache directory
-    with asset_manager.open(relative_path) as asset_file:
-        with open(output_path, 'wb') as output_file:
-            shutil.copyfileobj(asset_file, output_file)
-
-    # Return the URI
-    Uri = autoclass('android.net.Uri')
-    return Uri.parse(f"file://{output_path}")
-
-# # Example usage
-# image_uri = get_image_uri("imgs/icon.png")
-# print(image_uri)
-
-def send_notification(title, message, style=None, img_path=None, channel_id="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').
-    :param image: Image URL or drawable for 'big_picture' style.
-    :param channel_id: Notification channel ID.
-    """
-    # Get the required Java classes
-    PythonActivity = autoclass('org.kivy.android.PythonActivity')
-    NotificationManager = autoclass('android.app.NotificationManager')
-    NotificationChannel = autoclass('android.app.NotificationChannel')
-    NotificationCompatBuilder = autoclass('androidx.core.app.NotificationCompat$Builder')
-    NotificationCompatBigTextStyle = autoclass('androidx.core.app.NotificationCompat$BigTextStyle')
-    NotificationCompatBigPictureStyle = autoclass('androidx.core.app.NotificationCompat$BigPictureStyle')
-    NotificationCompatInboxStyle = autoclass('androidx.core.app.NotificationCompat$InboxStyle')
-    BitmapFactory = autoclass('android.graphics.BitmapFactory')
-
-    # Get the app's context and notification manager
-    context = PythonActivity.mActivity
-    notification_manager = context.getSystemService(context.NOTIFICATION_SERVICE)
-
-    # Notification Channel (Required for Android 8.0+)
-    if notification_manager.getNotificationChannel(channel_id) is None:
-        channel = NotificationChannel(
-            channel_id,
-            "Default Channel",
-            NotificationManager.IMPORTANCE_DEFAULT
-        )
-        notification_manager.createNotificationChannel(channel)
-
-    # Build the notification
-    builder = NotificationCompatBuilder(context, channel_id)
-    builder.setContentTitle(title)
-    builder.setContentText(message)
-    builder.setSmallIcon(context.getApplicationInfo().icon)
-
-    
-    # Get Image
-    if img_path:
-        try:
-            img_path = get_image_uri(img_path)
-        except Exception as e:
-            print('Failed getting Image path',e)
-    
-    # Apply styles
-    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_path))
-        big_picture_style = NotificationCompatBigPictureStyle()
-        big_picture_style.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)
-
-    # Show the notification
-    notification_manager.notify(random.randint(0, 100), builder.build())

android_notify-0.2/android_notify.egg-info/PKG-INFO

@@ -1,4 +0,0 @@
-Metadata-Version: 2.1
-Name: android-notify
-Version: 0.2
-Summary: A Python package for sending Android notifications.

android_notify-0.2/setup.py

@@ -1,9 +0,0 @@
-from setuptools import setup, find_packages
-
-setup(
-    name='android_notify',
-    version='0.2',
-    description='A Python package for sending Android notifications.',
-    packages=find_packages(),
-    install_requires=['pyjnius'],
-)