android-notify 1.60.4.dev0__tar.gz → 1.60.5__tar.gz

{android_notify-1.60.4.dev0 → android_notify-1.60.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: android-notify
-Version: 1.60.4.dev0
+Version: 1.60.5
 Summary: A Python package that simplifies creating Android notifications in Kivy and Flet apps.
 Author-email: Fabian <fector101@yahoo.com>
 License-Expression: MIT
@@ -79,32 +79,81 @@ In your **`buildozer.spec`** file, ensure you include the following:
 
 ```ini
 # Add pyjnius so ensure it's packaged with the build
-requirements = python3, kivy, pyjnius, android-notify==1.60.4.dev0
+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
+android.api = 35
 ```
 
 ### Flet apps:  
-
-In your `pyproject.toml` file, ensure you include the following:
-
+ In your `pyproject.toml` file, ensure you include the following:
 ```toml
 [tool.flet.android]
 dependencies = [
-  "pyjnius","android-notify==1.60.4.dev0"
+  "pyjnius","android-notify==1.60.5.dev0"
 ]
 
 [tool.flet.android.permission]
 "android.permission.POST_NOTIFICATIONS" = true
 ```
+- example of [complete flet pyproject.toml](https://github.com/Fector101/flet-app/blob/main/pyproject.toml)
+------
+## Installing without Androidx
+How to use without `gradle_dependencies`
+Use `android-notify==1.60.5.dev0` to install via `pip`
+### In Kivy
+```ini
+# buildozer.spec
+requirements = python3, kivy, pyjnius, android-notify==1.60.5.dev0
+```
 
-### Pydroid 3
-In the [pydroid 3](https://play.google.com/store/apps/details?id=ru.iiec.pydroid3) mobile app for running python code you can test some features.
-- In pip section where you're asked to insert `Libary name` paste `android-notify==1.60.4.dev0`
-
+### On Pydroid 3 
+On the [pydroid 3](https://play.google.com/store/apps/details?id=ru.iiec.pydroid3) mobile app for running python code you can test some features.
+- In pip section where you're asked to insert `Libary name` paste `android-notify==1.60.5.dev0`
+- Minimal working example 
+```py
+# Testing with `android-notify==1.60.5.dev0` on pydroid
+from kivy.app import App
+from kivy.uix.boxlayout import BoxLayout
+from kivy.uix.button import Button
+from android_notify import Notification
+from android_notify.core import asks_permission_if_needed
+
+
+class AndroidNotifyDemoApp(App):
+    def build(self):
+        layout = BoxLayout(orientation='vertical', spacing=10, padding=20)
+        layout.add_widget(Button(
+            text="Ask Notification Permission",
+            on_release=self.request_permission
+        ))
+        layout.add_widget(Button(
+            text="Send Notification",
+            on_release=self.send_notification
+        ))
+        return layout
+
+    def request_permission(self, *args):
+        asks_permission_if_needed(no_androidx=True)
+
+    def send_notification(self, *args):
+        Notification(
+            title="Hello from Android Notify",
+            message="This is a basic notification.",
+            channel_id="android_notify_demo",
+            channel_name="Android Notify Demo"
+        ).send()
+
+
+if __name__ == "__main__":
+    AndroidNotifyDemoApp().run()
+```
 
-### Testing
-Can be installed via `pip` For testing purposes:
+For IDE IntelliSense Can be installed via `pip install`:
 
 ```bash
 pip install android_notify
@@ -113,7 +162,7 @@ android-notify -v
 
 ## Documentation
 For Dev Version use
-```requirements = python3, kivy, pyjnius, https://github.com/Fector101/android_notify/archive/without-androidx.zip```
+```requirements = python3, kivy, pyjnius, https://github.com/Fector101/android_notify/archive/main.zip```
 
 
 To use colored text in your notifications:
@@ -121,13 +170,34 @@ To use colored text in your notifications:
 Lastly in your `buildozer.spec` file
 - Add `source.include_exts = xml` and `android.add_resources = ./res`
 
+To use Custom Sounds
+- Put audio files in `res/raw` folder,
+- Then from `buildozer.spec` point to res folder `android.add_resources = res`
+- and includes it's format `source.include_exts = wav`.
+
+Lastly From the code 
+```py
+# Create a custom notification channel with a unique sound resource for android 8+
+Notification.createChannel(
+    id="weird_sound_tester",
+    name="Weird Sound Tester",
+    description="A test channel used to verify custom notification sounds from the res/raw folder.",
+    res_sound_name="sneeze" # file name without .wav or .mp3
+)
+
+# Send a notification through the created channel
+n=Notification(
+    title="Custom Sound Notification",
+    message="This tests playback of a custom sound (sneeze.wav) stored in res/raw.",
+    channel_id="weird_sound_tester" # important tells notification to use right channel
+)
+n.setSound("sneeze")# for android 7 below 
+n.send()
+```
 For full documentation, examples, and advanced usage, API reference visit the
 [documentation](https://android-notify.vercel.app)
 
 ## ☕ Support the Project
 
-If you find this project helpful, consider buying me a coffee! 😊 Or Giving it a star on 🌟 [GitHub](https://github.com/Fector101/android_notify/) 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>
+If you find this project helpful, any support would help me continue working on open-source projects. I’m currently saving for a laptop to keep developing.
+[donate](https://www.buymeacoffee.com/fector101)

{android_notify-1.60.4.dev0 → android_notify-1.60.5}/README.md

@@ -56,32 +56,81 @@ In your **`buildozer.spec`** file, ensure you include the following:
 
 ```ini
 # Add pyjnius so ensure it's packaged with the build
-requirements = python3, kivy, pyjnius, android-notify==1.60.4.dev0
+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
+android.api = 35
 ```
 
 ### Flet apps:  
-
-In your `pyproject.toml` file, ensure you include the following:
-
+ In your `pyproject.toml` file, ensure you include the following:
 ```toml
 [tool.flet.android]
 dependencies = [
-  "pyjnius","android-notify==1.60.4.dev0"
+  "pyjnius","android-notify==1.60.5.dev0"
 ]
 
 [tool.flet.android.permission]
 "android.permission.POST_NOTIFICATIONS" = true
 ```
+- example of [complete flet pyproject.toml](https://github.com/Fector101/flet-app/blob/main/pyproject.toml)
+------
+## Installing without Androidx
+How to use without `gradle_dependencies`
+Use `android-notify==1.60.5.dev0` to install via `pip`
+### In Kivy
+```ini
+# buildozer.spec
+requirements = python3, kivy, pyjnius, android-notify==1.60.5.dev0
+```
 
-### Pydroid 3
-In the [pydroid 3](https://play.google.com/store/apps/details?id=ru.iiec.pydroid3) mobile app for running python code you can test some features.
-- In pip section where you're asked to insert `Libary name` paste `android-notify==1.60.4.dev0`
-
+### On Pydroid 3 
+On the [pydroid 3](https://play.google.com/store/apps/details?id=ru.iiec.pydroid3) mobile app for running python code you can test some features.
+- In pip section where you're asked to insert `Libary name` paste `android-notify==1.60.5.dev0`
+- Minimal working example 
+```py
+# Testing with `android-notify==1.60.5.dev0` on pydroid
+from kivy.app import App
+from kivy.uix.boxlayout import BoxLayout
+from kivy.uix.button import Button
+from android_notify import Notification
+from android_notify.core import asks_permission_if_needed
+
+
+class AndroidNotifyDemoApp(App):
+    def build(self):
+        layout = BoxLayout(orientation='vertical', spacing=10, padding=20)
+        layout.add_widget(Button(
+            text="Ask Notification Permission",
+            on_release=self.request_permission
+        ))
+        layout.add_widget(Button(
+            text="Send Notification",
+            on_release=self.send_notification
+        ))
+        return layout
+
+    def request_permission(self, *args):
+        asks_permission_if_needed(no_androidx=True)
+
+    def send_notification(self, *args):
+        Notification(
+            title="Hello from Android Notify",
+            message="This is a basic notification.",
+            channel_id="android_notify_demo",
+            channel_name="Android Notify Demo"
+        ).send()
+
+
+if __name__ == "__main__":
+    AndroidNotifyDemoApp().run()
+```
 
-### Testing
-Can be installed via `pip` For testing purposes:
+For IDE IntelliSense Can be installed via `pip install`:
 
 ```bash
 pip install android_notify
@@ -90,7 +139,7 @@ android-notify -v
 
 ## Documentation
 For Dev Version use
-```requirements = python3, kivy, pyjnius, https://github.com/Fector101/android_notify/archive/without-androidx.zip```
+```requirements = python3, kivy, pyjnius, https://github.com/Fector101/android_notify/archive/main.zip```
 
 
 To use colored text in your notifications:
@@ -98,13 +147,34 @@ To use colored text in your notifications:
 Lastly in your `buildozer.spec` file
 - Add `source.include_exts = xml` and `android.add_resources = ./res`
 
+To use Custom Sounds
+- Put audio files in `res/raw` folder,
+- Then from `buildozer.spec` point to res folder `android.add_resources = res`
+- and includes it's format `source.include_exts = wav`.
+
+Lastly From the code 
+```py
+# Create a custom notification channel with a unique sound resource for android 8+
+Notification.createChannel(
+    id="weird_sound_tester",
+    name="Weird Sound Tester",
+    description="A test channel used to verify custom notification sounds from the res/raw folder.",
+    res_sound_name="sneeze" # file name without .wav or .mp3
+)
+
+# Send a notification through the created channel
+n=Notification(
+    title="Custom Sound Notification",
+    message="This tests playback of a custom sound (sneeze.wav) stored in res/raw.",
+    channel_id="weird_sound_tester" # important tells notification to use right channel
+)
+n.setSound("sneeze")# for android 7 below 
+n.send()
+```
 For full documentation, examples, and advanced usage, API reference visit the
 [documentation](https://android-notify.vercel.app)
 
 ## ☕ Support the Project
 
-If you find this project helpful, consider buying me a coffee! 😊 Or Giving it a star on 🌟 [GitHub](https://github.com/Fector101/android_notify/) 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>
+If you find this project helpful, any support would help me continue working on open-source projects. I’m currently saving for a laptop to keep developing.
+[donate](https://www.buymeacoffee.com/fector101)

android_notify-1.60.5/android_notify/an_types.py

@@ -0,0 +1,328 @@
+"""For autocomplete Storing Reference to Available Methods"""
+from typing import Literal
+
+Importance = Literal['urgent', 'high', 'medium', 'low', 'none']
+"""
+    :argument urgent - Makes a sound and appears as a heads-up notification.
+    
+    :argument high - Makes a sound.
+    
+    :argument urgent - Makes no sound.
+    
+    :argument urgent - Makes no sound and doesn't appear in the status bar.
+    
+    :argument urgent - Makes no sound and doesn't in the status bar or shade.
+"""
+
+
+# For Dev
+# Idea for typing autocompletion and reference
+class Bundle:
+    def putString(self, key, value):
+        print(f"[MOCK] Bundle.putString called with key={key}, value={value}")
+
+    def putInt(self, key, value):
+        print(f"[MOCK] Bundle.putInt called with key={key}, value={value}")
+
+
+class String(str):
+    def __new__(cls, value):
+        print(f"[MOCK] String created with value={value}")
+        return str.__new__(cls, value)
+
+
+class Intent:
+    FLAG_ACTIVITY_NEW_TASK = 'FACADE_FLAG_ACTIVITY_NEW_TASK'
+    CATEGORY_DEFAULT = 'FACADE_FLAG_CATEGORY_DEFAULT'
+
+    def __init__(self, context='', activity=''):
+        self.obj = {}
+        print(f"[MOCK] Intent initialized with context={context}, activity={activity}")
+
+    def setAction(self, action):
+        print(f"[MOCK] Intent.setAction called with: {action}")
+        return self
+
+    def addFlags(self, *flags):
+        print(f"[MOCK] Intent.addFlags called with: {flags}")
+        return self
+
+    def setData(self, uri):
+        print(f"[MOCK] Intent.setData called with: {uri}")
+        return self
+
+    def setFlags(self, intent_flag):
+        print(f"[MOCK] Intent.setFlags called with: {intent_flag}")
+        return self
+
+    def addCategory(self, intent_category):
+        print(f"[MOCK] Intent.addCategory called with: {intent_category}")
+        return self
+
+    def getAction(self):
+        print("[MOCK] Intent.getAction called")
+        return self
+
+    def getStringExtra(self, key):
+        print(f"[MOCK] Intent.getStringExtra called with key={key}")
+        return self
+
+    def putExtra(self, key, value):
+        self.obj[key] = value
+        print(f"[MOCK] Intent.putExtra called with key={key}, value={value}")
+
+    def putExtras(self, bundle: Bundle):
+        self.obj['bundle'] = bundle
+        print(f"[MOCK] Intent.putExtras called with bundle={bundle}")
+
+
+class PendingIntent:
+    FLAG_IMMUTABLE = ''
+    FLAG_UPDATE_CURRENT = ''
+
+    def getActivity(self, context, value, action_intent, pending_intent_type):
+        print(
+            f"[MOCK] PendingIntent.getActivity called with context={context}, value={value}, action_intent={action_intent}, type={pending_intent_type}")
+
+
+class BitmapFactory:
+    def decodeStream(self, stream):
+        print(f"[MOCK] BitmapFactory.decodeStream called with stream={stream}")
+
+
+class BuildVersion:
+    SDK_INT = 0
+
+class Manifest:
+    POST_NOTIFICATIONS = 'FACADE_IMPORT'
+
+class Settings:
+    ACTION_APP_NOTIFICATION_SETTINGS = 'FACADE_IMPORT_ACTION_APP_NOTIFICATION_SETTINGS'
+    EXTRA_APP_PACKAGE = 'FACADE_IMPORT_EXTRA_APP_PACKAGE'
+    ACTION_APPLICATION_DETAILS_SETTINGS = 'FACADE_IMPORT_ACTION_APPLICATION_DETAILS_SETTINGS'
+
+class Uri:
+    def __init__(self,package_name):
+        print("FACADE_URI")
+
+class NotificationManager:
+    pass
+
+
+class NotificationChannel:
+    def __init__(self, channel_id, channel_name, importance):
+        self.description = None
+        self.channel_id = channel_id
+        self.channel = None
+        print(
+            f"[MOCK] NotificationChannel initialized with id={channel_id}, name={channel_name}, importance={importance}")
+
+    def createNotificationChannel(self, channel):
+        self.channel = channel
+        print(f"[MOCK] NotificationChannel.createNotificationChannel called with channel={channel}")
+
+    def getNotificationChannel(self, channel_id):
+        self.channel_id = channel_id
+        print(f"[MOCK] NotificationChannel.getNotificationChannel called with id={channel_id}")
+
+    def setDescription(self, description):
+        self.description = description
+        print(f"[MOCK] NotificationChannel.setDescription called with description={description}")
+
+    def getId(self):
+        print(f"[MOCK] NotificationChannel.getId called, returning {self.channel_id}")
+        return self.channel_id
+
+
+class IconCompat:
+    def createWithBitmap(self, bitmap):
+        print(f"[MOCK] IconCompat.createWithBitmap called with bitmap={bitmap}")
+
+
+class Color:
+    def __init__(self):
+        print("[MOCK] Color initialized")
+
+    def parseColor(self, color: str):
+        print(f"[MOCK] Color.parseColor called with color={color}")
+        return self
+
+
+class RemoteViews:
+    def __init__(self, package_name, small_layout_id):
+        print(f"[MOCK] RemoteViews initialized with package_name={package_name}, layout_id={small_layout_id}")
+
+    def createWithBitmap(self, bitmap):
+        print(f"[MOCK] RemoteViews.createWithBitmap called with bitmap={bitmap}")
+
+    def setTextViewText(self, id, text):
+        print(f"[MOCK] RemoteViews.setTextViewText called with id={id}, text={text}")
+
+    def setTextColor(self, id, color: Color):
+        print(f"[MOCK] RemoteViews.setTextColor called with id={id}, color={color}")
+
+
+class NotificationManagerCompat:
+    IMPORTANCE_HIGH = 4
+    IMPORTANCE_DEFAULT = 3
+    IMPORTANCE_LOW = ''
+    IMPORTANCE_MIN = ''
+    IMPORTANCE_NONE = ''
+
+
+class NotificationCompat:
+    DEFAULT_ALL = 3
+    PRIORITY_HIGH = 4
+    PRIORITY_DEFAULT = ''
+    PRIORITY_LOW = ''
+    PRIORITY_MIN = ''
+
+
+class MActions:
+    def clear(self):
+        """This Removes all buttons"""
+        print('[MOCK] MActions.clear called')
+
+
+class NotificationCompatBuilder:
+    def __init__(self, context, channel_id):
+        self.mActions = MActions()
+        pass
+    def setProgress(self,max_value,current_value,endless):
+        pass
+    def setStyle(self,style):
+        pass
+    def setContentTitle(self,title):
+        pass
+    def setContentText(self,text):
+        pass
+
+    def setSmallIcon(self, icon):
+        print(f"[MOCK] setSmallIcon called with icon={icon}")
+
+    def setLargeIcon(self, icon):
+        print(f"[MOCK] setLargeIcon called with icon={icon}")
+
+    def setAutoCancel(self, auto_cancel: bool):
+        print(f"[MOCK] setAutoCancel called with auto_cancel={auto_cancel}")
+
+    def setPriority(self, priority: Importance):
+        print(f"[MOCK] setPriority called with priority={priority}")
+
+    def setDefaults(self, defaults):
+        print(f"[MOCK] setDefaults called with defaults={defaults}")
+
+    def setOngoing(self, persistent: bool):
+        print(f"[MOCK] setOngoing called with persistent={persistent}")
+
+    def setOnlyAlertOnce(self, state):
+        print(f"[MOCK] setOnlyAlertOnce called with state={state}")
+
+    def build(self):
+        print("[MOCK] build called")
+
+    def setContentIntent(self, pending_action_intent: PendingIntent):
+        print(f"[MOCK] setContentIntent called with {pending_action_intent}")
+
+    def addAction(self, icon_int, action_text, pending_action_intent):
+        print(f"[MOCK] addAction called with icon={icon_int}, text={action_text}, intent={pending_action_intent}")
+
+    def setShowWhen(self, state):
+        print(f"[MOCK] setShowWhen called with state={state}")
+
+    def setWhen(self, time_ms):
+        print(f"[MOCK] setWhen called with time_ms={time_ms}")
+
+    def setCustomContentView(self, layout):
+        print(f"[MOCK] setCustomContentView called with layout={layout}")
+
+    def setCustomBigContentView(self, layout):
+        print(f"[MOCK] setCustomBigContentView called with layout={layout}")
+
+    def setSubText(self, text):
+        print(f"[MOCK] setSubText called with text={text}")
+
+    def setColor(self, color: Color) -> None:
+        print(f"[MOCK] setColor called with color={color}")
+
+
+class NotificationCompatBigTextStyle:
+    def bigText(self, body):
+        print(f"[MOCK] NotificationCompatBigTextStyle.bigText called with body={body}")
+        return self
+
+
+class NotificationCompatBigPictureStyle:
+    def bigPicture(self, bitmap):
+        print(f"[MOCK] NotificationCompatBigPictureStyle.bigPicture called with bitmap={bitmap}")
+        return self
+
+
+class NotificationCompatInboxStyle:
+    def addLine(self, line):
+        print(f"[MOCK] NotificationCompatInboxStyle.addLine called with line={line}")
+        return self
+
+
+class NotificationCompatDecoratedCustomViewStyle:
+    def __init__(self):
+        print("[MOCK] NotificationCompatDecoratedCustomViewStyle initialized")
+
+
+class Permission:
+    POST_NOTIFICATIONS = ''
+
+
+def check_permission(permission: Permission.POST_NOTIFICATIONS):
+    print(f"[MOCK] check_permission called with {permission}")
+    print(permission)
+
+
+def request_permissions(_list: [], _callback):
+    print(f"[MOCK] request_permissions called with {_list}")
+    _callback()
+
+
+class AndroidActivity:
+    def bind(self, on_new_intent):
+        print(f"[MOCK] AndroidActivity.bind called with {on_new_intent}")
+
+    def unbind(self, on_new_intent):
+        print(f"[MOCK] AndroidActivity.unbind called with {on_new_intent}")
+
+
+class PythonActivity:
+    mActivity = "[MOCK] mActivity used"
+    def __init__(self):
+        print("[MOCK] PythonActivity initialized")
+
+
+class DummyIcon:
+    icon = 101
+
+    def __init__(self):
+        print("[MOCK] DummyIcon initialized")
+
+
+class Context:
+    def __init__(self):
+        print("[MOCK] Context initialized")
+        pass
+
+    @staticmethod
+    def getApplicationInfo():
+        print("[MOCK] Context.getApplicationInfo called")
+        return DummyIcon
+
+    @staticmethod
+    def getResources():
+        print("[MOCK] Context.getResources called")
+        return None
+
+    @staticmethod
+    def getPackageName():
+        print("[MOCK] Context.getPackageName called")
+        return None  # TODO get package name from buildozer.spec file
+
+# Now writing Knowledge from errors
+# notify.(int, Builder.build()) # must be int