dbus-notifier 0.2.1__py2.py3-none-any.whl

dbus_notifier/notifysender.py

@@ -0,0 +1,84 @@
+"""
+This module provides very simple dbus notifications.
+"""
+import os
+
+import dbusnotify
+from dotenv import dotenv_values
+
+
+class NotifySender:
+    """
+    This class represents a sender of dbus notifications. It can post individual messages, or you can initialise it
+    with a dictionary of messages. If the dictionary is present, notifications can be posted by calling the method
+    notify with a message selection key.
+    """
+
+    def __init__(self, title, messages=None):
+        self._title = None
+        self._messages = None
+        self.title = title
+        self.messages = messages
+
+    @property
+    def title(self):  # pylint: disable=missing-function-docstring
+        return self._title
+
+    @title.setter
+    def title(self, in_str=None):
+        self._title = in_str or ""
+
+    @property
+    def messages(self):
+        """
+        A dictionary of pre-prepared messages that can be selected using a key.
+        :return: The value of a private member variable
+        """
+        return self._messages
+
+    @messages.setter
+    def messages(self, in_dict=None):
+        self._messages = in_dict or {}
+
+    def _post_notification(self, in_title="", in_description=""):
+        """
+        This private method posts notifications
+        :param in_title: A string containing the notification title
+        :param in_description: A string containing the notification message
+        :return: void
+        """
+        ve_path = os.getenv("VIRTUAL_ENV")
+        ve_config = dotenv_values(os.path.join(ve_path, ".env_dbus_notifier"))
+
+        if ve_config:
+            icon_file = os.path.join(ve_path, ve_config.get("DBUS_NOTIFIER_ICON", ''))
+        else:
+            config = dotenv_values(os.path.join(os.getcwd(), '.env_dbus_notifier'))
+            icon_file = os.path.join(os.getcwd(), config.get("DBUS_NOTIFIER_ICON", ''))
+
+        if not os.path.isfile(icon_file):
+            icon_file = ""
+        dbusnotify.write(
+            in_description,
+            title=in_title if in_title else self.title,
+            icon=icon_file,  # On Windows .ico is required, on Linux - .png
+        )
+
+    def notify(self, message=None, select_key=None):
+        """
+        This method posts notifications.
+        :param message: A string containing the notification message
+        :param select_key: A key value to select a message from a dictionary of messages, if available (this key is
+        not needed if `message` is provided)
+        :return: void
+        """
+        title = self.title
+
+        if select_key and self.messages:
+            self._post_notification(title, self.messages.get(select_key, ""))
+            return
+
+        if not message:
+            return
+
+        self._post_notification(title, message)

dbus_notifier-0.2.1.data/data/.env_dbus_notifier

@@ -0,0 +1 @@
+DBUS_NOTIFIER_ICON=dbusnotifier/icons/feather_on_grey.png

dbus_notifier-0.2.1.dist-info/METADATA

@@ -0,0 +1,134 @@
+Metadata-Version: 2.4
+Name: dbus-notifier
+Version: 0.2.1
+Summary: A small dbus notifier package
+Author: Adam Bukolt
+Author-email: Adam Bukolt <abukolt@gmx.com>
+Project-URL: Homepage, https://github.com/adambmarsh/dbusnotify
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: annotated-types>=0.6.0
+Requires-Dist: astroid>=3.1.0
+Requires-Dist: attrs>=23.2.0
+Requires-Dist: bleach>=6.1.0
+Requires-Dist: build>=1.1.1
+Requires-Dist: certifi>=2024.2.2
+Requires-Dist: cffi>=1.16.0
+Requires-Dist: charset-normalizer>=3.3.2
+Requires-Dist: check-wheel-contents>=0.6.0
+Requires-Dist: click>=8.1.7
+Requires-Dist: cryptography>=42.0.5
+Requires-Dist: dbus-next>=0.2.3
+Requires-Dist: dbus-python>=1.3.2
+Requires-Dist: dbusnotify>=0.0.2
+Requires-Dist: dill>=0.3.8
+Requires-Dist: docutils>=0.20.1
+Requires-Dist: idna>=3.6
+Requires-Dist: importlib-metadata>=7.1.0
+Requires-Dist: isort>=5.13.2
+Requires-Dist: jaraco-classes>=3.3.1
+Requires-Dist: jaraco-context>=4.3.0
+Requires-Dist: jaraco-functools>=4.0.0
+Requires-Dist: jeepney>=0.8.0
+Requires-Dist: keyring>=25.0.0
+Requires-Dist: markdown-it-py>=3.0.0
+Requires-Dist: mccabe>=0.7.0
+Requires-Dist: mdurl>=0.1.2
+Requires-Dist: more-itertools>=10.2.1
+Requires-Dist: nh3>=0.2.17
+Requires-Dist: packaging>=24.0
+Requires-Dist: pkginfo>=1.10.0
+Requires-Dist: platformdirs>=4.2.0
+Requires-Dist: pycodestyle>=2.11.1
+Requires-Dist: pycparser>=2.21
+Requires-Dist: pydantic>=2.6.4
+Requires-Dist: pydantic-core>=2.17.0
+Requires-Dist: pyflakes>=3.2.0
+Requires-Dist: pygments>=2.17.2
+Requires-Dist: pylint>=3.1.0
+Requires-Dist: pyproject-hooks>=1.0.0
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: readme-renderer>=43.0
+Requires-Dist: requests>=2.31.0
+Requires-Dist: requests-toolbelt>=1.0.0
+Requires-Dist: rfc3986>=2.0.0
+Requires-Dist: rich>=13.7.1
+Requires-Dist: secretstorage>=3.3.3
+Requires-Dist: setuptools>=80.9.0
+Requires-Dist: six>=1.16.0
+Requires-Dist: tomli>=2.0.1
+Requires-Dist: tomlkit>=0.12.4
+Requires-Dist: twine>=5.0.0
+Requires-Dist: typing-extensions>=4.10.0
+Requires-Dist: urllib3>=2.2.1
+Requires-Dist: webencodings>=0.5.1
+Requires-Dist: wheel-filename>=1.4.1
+Requires-Dist: zipp>=3.18.1
+Dynamic: author
+Dynamic: license-file
+Dynamic: requires-python
+
+# dbus-notifier #
+
+This library offers a simple means of generating dbus notifications on Linux. 
+
+## Installation and Usage
+
+Make sure at least Python 3.* is installed on the target Linux system. 
+
+Install virtualenv in which to install `dbus-notifier`.
+
+In the virtual environment, run `pip3 install dbus-notifier`
+
+In the Python code to use dbus-notifier:
+
+```commandline
+from dbusnotifier.dbusnotifier import NotifySender
+
+```
+The simplest code instantiating NotifySender and sending a dbus notification is this:
+
+```commandline
+    sender = NotifySender(title="My notifier")
+    ...
+    sender.notify(message="Hi!")
+```
+The above code results in a single message "Hi!" being posting in the notification area.
+
+A more complex scenario supported by dbus-notifier is to create a dictionary with a selection of messages, where each
+key identifies a message. The code below illustrates this case:
+
+```
+    sender = NotifySender(title="My notifier", messages={'0': "Success", '1': "Failed"})
+    
+    sender.notify(select_key='0')
+```
+
+
+## Dependencies
+
+Please see `pyproject.toml`.
+
+## Status
+
+Mar 2023 First draft, tested locally on Manjaro Linux.
+Apr 2025 release.
+
+## Copyright
+
+Copyright Adam Bukolt
+
+Note that the copyright refers to the code and scripts in this repository and
+expressly not to any third-party dependencies.
+
+## License
+
+MIT
+
+Icons included with this program were created by and are the sole property of the copyright holder.
+
+Note that separate licenses apply to third-party dependencies.

dbus_notifier-0.2.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+dbus_notifier/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dbus_notifier/notifysender.py,sha256=oRwb4nEpPOWAro2-2gDquItHXnul2O7iXCnICNgjloQ,2741
+dbus_notifier/icons/feather_on_grey.png,sha256=d3AL4ZgDeGeGVA8w_rsDMq44OqXLm38HM4wbmsbBBfQ,9566
+dbus_notifier-0.2.1.data/data/.env_dbus_notifier,sha256=98LpNZCFwtMk1soGOfOEF02pVH5PnF85XZ7fewoAIBg,58
+dbus_notifier-0.2.1.data/data/dbus_notifier/icons/feather_on_grey.png,sha256=d3AL4ZgDeGeGVA8w_rsDMq44OqXLm38HM4wbmsbBBfQ,9566
+dbus_notifier-0.2.1.dist-info/licenses/LICENSE,sha256=L1cs52IMCKn4dLji4fxcFqLkRkRdahfy-Lvl1lhlrxo,1068
+dbus_notifier-0.2.1.dist-info/METADATA,sha256=TexyVXqlcRwZ6dxq4CNcpHUL4PxBkgLjM0BNgqlGGfw,3900
+dbus_notifier-0.2.1.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
+dbus_notifier-0.2.1.dist-info/top_level.txt,sha256=GLRbV7kVsCZ-MygBlXupUb5lHhkLSPSjPSpuMlI9EmM,14
+dbus_notifier-0.2.1.dist-info/RECORD,,

dbus_notifier-0.2.1.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any
+

dbus_notifier-0.2.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Adam Bukolt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dbus_notifier-0.2.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+dbus_notifier