android-notify 1.3__py3-none-any.whl → 1.60.6.dev0__py3-none-any.whl

android_notify-1.3.dist-info/METADATA

@@ -1,350 +0,0 @@
-Metadata-Version: 2.1
-Name: android-notify
-Version: 1.3
-Summary: A Python package that simpilfies creating Android Post 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,post-notifications,pyjnius,android-notifications,kivy-notifications,python-android,mobile-development,push-notifications,mobile-app,kivy-application
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: Android
-Classifier: Development Status :: 5 - Production/Stable
-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-Notifiy
-
-A Python library for effortlessly creating and managing Android notifications  in Kivy android apps.
-Supports various styles and ensures seamless integration and customization.
-
-## Features
-
-- Compatible with Android 8.0+.
-- Supports including images in notifications.
-- Support for multiple notification styles:
-  - Progress
-  - Big Picture
-  - Inbox
-  - Big Text
-  - Large Icon
-
-This module automatically handles:
-
-- Permission requests for notifications
-- Customizable notification channels.
-
-## Installation
-
-This package is available on PyPI and can be installed via pip:
-
-```bash
-pip install android-notify
-```
-
-## **Dependencies**
-
-**Prerequisites:**  
-
-- 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
-```
-
----
-
-## Basic Usage
-
-```python
-from android_notify import Notification
-
-# Create a simple notification
-notification = Notification(
-    title="Hello",
-    message="This is a basic notification"
-)
-notification.send()
-```
-
-**Sample Image:**  
-![basic notification img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/basicnoti.jpg)
-
-## Notification Styles
-
-The library supports multiple notification styles:
-
-1. `simple` - Basic notification with title and message
-2. `progress` - Shows a progress bar
-3. `big_text` - Expandable notification with long text
-4. `inbox` - List-style notification
-5. `big_picture` - Notification with a large image
-6. `large_icon` - Notification with a custom icon
-7. `both_imgs` - Combines big picture and large icon
-8. `custom` - For custom notification styles
-
-### Style Examples
-
-#### Notification with an Image (Big Picture Style)
-
-```python
-# Image notification
-notification = Notification(
-    title='Picture Alert!',
-    message='This notification includes an image.',
-    style="big_picture",
-    big_picture_path="assets/imgs/photo.png"
-)
-```
-
-**Sample Image:**
-![big_picture img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/bigpicturenoti.jpg)
-
-#### Inbox Notification Style
-
-```python
-# Send a notification with inbox style
-notification = Notification(
-    title='Inbox Notification',
-    message='Line 1\nLine 2\nLine 3',
-    style='inbox'
-)
-```
-
-**Sample Image:**
-![Inbox Notification sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/inboxnoti.jpg)
-
-#### Big text notification (Will Display as simple text if Device dosen't support)
-
-```python
-notification = Notification(
-    title="Article",
-    message="Long article content...",
-    style="big_text"
-)
-```
-
-#### Progress bar notification
-
-```python
-notification = Notification(
-    title="Download",
-    message="Downloading file...",
-    style="progress",
-    progress_max_value=100,
-    progress_current_value=0
-)
-
-```
-
-**Sample Image:**
-![progress img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/progress.jpg)
-
-#### Notification with an Image (Large Icon Style)
-
-```python
-notification = Notification(
-    title="Completed download",
-    message="profile.jpg",
-    style="large_icon",
-    large_icon_path="assets/imgs/profile.png"
-)
-
-```
-
-**Sample Image:**  
-![large_icon img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/large_icon.jpg)
-
-## Advanced Features
-
-### Updating Notifications
-
-```python
-notification = Notification(title="Initial Title")
-notification.send()
-
-# Update title
-notification.updateTitle("New Title")
-
-# Update message
-notification.updateMessage("New Message")
-```
-
-### Progress Bar Management
-
-```python
-notification = Notification(
-    title="Download Progress",
-    style="progress"
-)
-
-# Update progress
-notification.updateProgressBar(50, "50% Complete")
-
-# Remove progress bar
-notification.removeProgressBar("Download Complete")
-```
-
-### Channel Management
-
-Notifications are organized into channels. You can customize the channel name and ID:
-
-- Custom Channel Name's Gives User ability to turn on/off specific
-
-```python
-notification = Notification(
-    title="Download finished",
-    message="How to Catch a Fish.mp4",
-    channel_name="Download Notifications",  # Will create User-visible name "downloads"
-    channel_id="custom_downloads"  # Optional: specify custom channel ID
-)
-```
-
-**Sample Image:**  
-![channels img sample](https://raw.githubusercontent.com/Fector101/android_notify/main/docs/imgs/channel_name.jpg)
-
-### Silent Notifications
-
-To send a notification without sound or heads-up display:
-
-```python
-notification = Notification(title="Silent Update")
-notification.send(silent=True)
-```
-
-### 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 Notification, NotificationStyles
-notification = Notification(
-    title="New Photo",
-    message="Check out this image",
-    style=NotificationStyles.BIG_PICTURE,
-    big_picture_path="assets/imgs/photo.png"
-).send()
-```
-
-## Development Mode
-
-When developing on non-Android platforms, the library provides debugging output:
-
-```python
-# Enable logs (default is True when not on Android)
-Notification.logs = True
-
-# Create notification for testing
-notification = Notification(title="Test")
-notification.send()
-# Will print notification properties instead of sending
-```
-
-## Image Requirements
-
-- Images must be located within your app's asset folder
-- Supported paths are relative to your app's storage path
-- Example: `assets/imgs/icon.png`
-
-## Error Handling
-
-The library validates arguments and provides helpful error messages:
-
-- Invalid style names will suggest the closest matching style
-- Invalid arguments will list all valid options
-- Missing image files will raise FileNotFoundError with the attempted path
-
-## Limitations
-
-1. Only works on Android devices
-2. Images must be within the app's storage path
-3. Channel names are limited to 40 characters
-4. Channel IDs are limited to 50 characters
-
-## Best Practices
-
-1. Always handle permissions appropriately
-2. Use meaningful channel names for organization
-3. Keep progress bar updates reasonable (don't update too frequently)
-4. Test notifications on different Android versions
-5. Consider using silent notifications for frequent updates
-
-## Debugging Tips
-
-1. Enable logs during development: `Notification.logs = True`
-2. Check channel creation with Android's notification settings
-3. Verify image paths before sending notifications
-4. Test different styles to ensure proper display
-
-Remember to check Android's notification documentation for best practices and guidelines regarding notification frequency and content.
-
-## 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: [Android Notify Repo](https://github.com/Fector101/android_notify)
-- Twitter: [FabianDev_](https://twitter.com/intent/user?user_id=1246911115319263233)
-
-For feedback or contributions, feel free to reach out!
-
----
-
-## ☕ 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>
-
----
-
-## Acknowledgments
-
-- This Project was thoroughly Tested by the [Laner Project](https://github.com/Fector101/Laner/) - A application for Securely Transfering Files Wirelessly between your PC and Phone.
-- Thanks to the Kivy and Pyjnius communities.
-
----
-
-## 🌐 **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.3.dist-info/RECORD

@@ -1,9 +0,0 @@
-android_notify/__init__.py,sha256=dAcsj7M_KHBOira9AVk4LtFFXRHTYsn6tza4Oz7T1MM,107
-android_notify/__main__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-android_notify/core.py,sha256=hHzBnVw25x_WpMHp_HPKCuHEL2mQ7IHC_I3EqQZylas,6081
-android_notify/styles.py,sha256=I2p31qStg9DaML9U4nXRvdpGzpppK6RS-qlDKuOv_Tk,328
-android_notify/sword.py,sha256=8v28Q9x3CRRa3xDbHUd8629S5KvLy7xnjSygbqT-coQ,16271
-android_notify-1.3.dist-info/METADATA,sha256=fA2YdjiuZKnEWirQdnzci1l4di-EXmphkdlp41I0FzU,9831
-android_notify-1.3.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-android_notify-1.3.dist-info/top_level.txt,sha256=IR1ONMrRSRINZpWn2X0dL5gbWwWINsK7PW8Jy2p4fU8,15
-android_notify-1.3.dist-info/RECORD,,