android-notify 1.61.3

A Python package that simplifies creating Android notifications in Kivy and Flet apps.

Android-Notify

Android Notify is a Python library for effortlessly creating and managing Android notifications in Kivy and Flet apps.

Supports various styles and ensures seamless integration, customization and Pythonic APIs.

Features

• Multiple Notification Styles: Support for various notification styles including:

  • Simple text notifications
  • Progress bar notifications (determinate and indeterminate)
  • Large icon notifications
  • Big picture notifications
  • Combined image styles
  • Custom notification Icon - images section
  • Big text notifications
  • Inbox-style notifications
  • Colored texts and Icons

• Rich Functionality:

  • Add action buttons with custom callbacks
  • Update notification content dynamically
  • Manage progress bars with fine-grained control
  • Custom notification channels for Android 8.0+ (Creating and Deleting)
  • Silent notifications
  • Persistent notifications
  • Click handlers and callbacks
  • Cancel Notifications
  • Use Custom Sound
  • Vibration section

Quick Start

from android_notify import Notification

# Simple notification
Notification(
    title="Hello",
    message="This is a basic notification."
).send()

Sample Image:

Installation

Kivy apps:

In your buildozer.spec file, ensure you include the following:

# Add pyjnius so ensure it's packaged with the build
requirements = python3, kivy, pyjnius, android-notify
# Add permission for notifications
android.permissions = POST_NOTIFICATIONS

# Required dependency (write exactly as shown, no quotation marks)
android.gradle_dependencies = androidx.core:core-ktx:1.15.0
android.enable_androidx = True
android.api = 35

Desktop

For IDE IntelliSense Can be installed via pip install:

pip install android_notify
android-notify -v

---

Installing without Androidx

How to use without gradle_dependencies Use android-notify==1.61.3.dev0 to install via pip

Flet apps:

In your pyproject.toml file, ensure you include the following:

[tool.flet.android]
dependencies = [
  "pyjnius","android-notify==1.61.3.dev0"
]

[tool.flet.android.permission]
"android.permission.POST_NOTIFICATIONS" = true

• example of complete flet pyproject.toml

In Kivy

# buildozer.spec
requirements = python3, kivy, pyjnius, android-notify==1.61.3.dev0

On Pydroid 3

On the pydroid 3 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.61.3.dev0
• Minimal working example

# Testing with `android-notify==1.61.3.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(legacy=True)

    def send_notification(self, *args):
        Notification(
            title="Hello from Android Notify",
            message="This is a basic notification."
        ).send()


if __name__ == "__main__":
    AndroidNotifyDemoApp().run()

Documentation

For Dev Version usage

requirements = python3, kivy, pyjnius, https://github.com/Fector101/android_notify/archive/main.zip

Add Data to Notification

• NotificationHandler.data_object returns a dict of data in the clicked notification
• setData can also be called after send to change data_object stored
• Use name if value is constant Notification(name="change page")

from android_notify import Notification, NotificationHandler

    def build(self):
        notification = Notification(title="Hello")
        notification.setData({"next wallpaper path": "test.jpg"})
        notification.send()

    def on_start(self):
        notification_data = NotificationHandler.data_object  # {"next wallpaper path": "test.jpg",...}
        print(notifcation_data)

    def on_resume(self):
        notification_data = NotificationHandler.data_object  # {"next wallpaper path": "test.jpg",...}
        print(notifcation_data)

For full documentation, examples, and advanced usage, API reference visit the documentation

☕ Support the Project

If you find this project helpful, your support would help me continue working on open-source projects donate

Bug Reports & Feature Requests

Found a bug or have an idea for a new feature?
Feel free to open an issue here

When reporting a bug, try to include:

• Device name
• Android version
• Steps to reproduce the issue
• Screenshots or logs (if possible)

Feature suggestions are also welcome.