O
+| + | +
P
+
|
-
O
-O
R
R
W
Welcome to pynotification’s documentation!
-——–PyNotification——–¶
-
-
-Notify¶
+
+PyNotification¶
Module to trigger OS agnostic notifications.
--
-notifier.notify.default_logger() Logger¶
+-
+pynotification.pynotifier.default_logger() Logger¶
Configure default logger.
--
-notifier.notify.notify(title: AnyStr, message: AnyStr, icon: Optional[Union[str, PathLike]] = None, debug: bool = False, logger: Optional[Logger] = None, destroy: bool = False) NoReturn¶
+-
+pynotification.pynotifier.pynotifier(title: AnyStr, message: AnyStr, icon: Optional[Union[str, PathLike]] = None, debug: bool = False, logger: Optional[Logger] = None, destroy: bool = False) NoReturn¶
Triggers a system notification.
-
-Module¶
+
+Module¶
Module to trigger notifications in WindowsOS, using windows binaries for API and GUI.
>>> WindowsNotifications
--
-class notifier.mod.WindowsBalloonTip(title: str, msg: str, icon: Union[str, PathLike], debug: bool, logger: Logger, destroy: bool)¶
+-
+class pynotification.mod.WindowsBalloonTip(title: str, msg: str, icon: Union[str, PathLike], debug: bool, logger: Logger, destroy: bool)¶
Instantiates WindowsBalloonTip object as a dedicated process to trigger notification in Windows OS.
>>> WindowsBalloonTip
@@ -144,14 +141,14 @@ ——–PyNotification——–
--
-notify() Union[bool, str]¶
+-
+notify() Union[bool, str]¶
Run notification as balloon window tip.
--
-on_destroy(*args, **kwargs) NoReturn¶
+-
+on_destroy(*args, **kwargs) NoReturn¶
Destroys the notification window created.
- Parameters:
@@ -203,9 +200,8 @@ Indices and tablesTable of Contents
- Welcome to pynotification’s documentation!
-- ——–PyNotification——–
-- Notify
-- Module
+- PyNotification
+- Module
- Indices and tables
diff --git a/docs/objects.inv b/docs/objects.inv
index 36063f9..c0c1061 100644
Binary files a/docs/objects.inv and b/docs/objects.inv differ
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
index 7f90330..39f0716 100644
--- a/docs/py-modindex.html
+++ b/docs/py-modindex.html
@@ -44,28 +44,28 @@ Navigation
Python Module Index
- n
+ p
- notifier
+ pynotification
- notifier.mod
+ pynotification.mod
- notifier.notify
+ pynotification.pynotifier
diff --git a/docs/searchindex.js b/docs/searchindex.js
index 694e97b..8cc7ac3 100644
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["PyNotification", "Welcome to pynotification\u2019s documentation!"], "terms": {"platform": 0, "support": [0, 1], "deploy": 0, "python": 0, "modul": 0, "trigger": [0, 1], "system": [0, 1], "notif": [0, 1], "linux": [0, 1], "window": [0, 1], "maco": 0, "m": 0, "pip": 0, "from": 0, "notifi": 0, "import": 0, "titl": [0, 1], "test": 0, "messag": [0, 1], "icon": [0, 1], "custom": [0, 1], "us": [0, 1], "oper": 0, "choos": 0, "ani": [0, 1], "pre": 0, "defin": 0, "png": [0, 1], "file": [0, 1], "ico": [0, 1], "default": [0, 1], "destroi": [0, 1], "boolean": [0, 1], "valu": [0, 1], "box": 0, "after": 0, "debug": [0, 1], "displai": [0, 1], "log": [0, 1], "form": 0, "info": 0, "warn": 0, "error": [0, 1], "logger": [0, 1], "bring": [0, 1], "your": [0, 1], "own": [0, 1], "docstr": 0, "format": 0, "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "clean": 0, "commit": 0, "hook": 0, "flake8": 0, "isort": 0, "requir": 0, "changelog": 0, "gener": 0, "revers": 0, "f": 0, "release_not": 0, "rst": 0, "t": [0, 1], "precommit": 0, "ensur": 0, "doc": 0, "creation": 0, "ar": 0, "run": [0, 1], "everi": 0, "sphinx": 0, "5": 0, "1": 0, "recommonmark": 0, "all": 0, "http": 0, "org": 0, "project": 0, "thevickypedia": 0, "github": 0, "io": 0, "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "instal": 1, "usag": 1, "option": 1, "argument": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "pypi": 1, "packag": 1, "runbook": 1, "licens": 1, "copyright": 1, "o": 1, "agnost": 1, "default_logg": 1, "configur": 1, "return": 1, "object": 1, "an": 1, "type": 1, "anystr": 1, "union": 1, "str": 1, "pathlik": 1, "none": 1, "bool": 1, "fals": 1, "noreturn": 1, "paramet": 1, "ha": 1, "go": 1, "add": 1, "show": 1, "output": 1, "balloon": 1, "immedi": 1, "person": 1, "both": 1, "pleas": 1, "thi": 1, "doesn": 1, "guarante": 1, "pop": 1, "up": 1, "built": 1, "tool": 1, "how": 1, "i": 1, "sole": 1, "reli": 1, "set": 1, "windowso": 1, "binari": 1, "api": 1, "gui": 1, "windowsnotif": 1, "class": 1, "mod": 1, "windowsballoontip": 1, "msg": 1, "instanti": 1, "dedic": 1, "process": 1, "initi": 1, "assign": 1, "creat": 1, "member": 1, "receiv": 1, "fashion": 1, "send": 1, "tip": 1, "flag": 1, "wa": 1, "success": 1, "otherwis": 1, "string": 1, "on_destroi": 1, "arg": 1, "kwarg": 1, "keyword": 1, "lparam": 1, "hwnd": 1, "wparam": 1, "index": 1, "search": 1, "page": 1}, "objects": {"notifier": [[1, 0, 0, "-", "mod"], [1, 0, 0, "-", "notify"]], "notifier.mod": [[1, 1, 1, "", "WindowsBalloonTip"]], "notifier.mod.WindowsBalloonTip": [[1, 2, 1, "", "notify"], [1, 2, 1, "", "on_destroy"], [1, 2, 1, "", "run"]], "notifier.notify": [[1, 3, 1, "", "default_logger"], [1, 3, 1, "", "notify"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "function", "Python function"]}, "titleterms": {"pynotif": [0, 1], "instal": 0, "usag": 0, "option": 0, "argument": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "welcom": 1, "": 1, "document": 1, "read": 1, "me": 1, "notifi": 1, "modul": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}})
\ No newline at end of file
+Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["PyNotification", "Welcome to pynotification\u2019s documentation!"], "terms": {"platform": 0, "support": [0, 1], "deploy": 0, "python": 0, "modul": 0, "trigger": [0, 1], "system": [0, 1], "notif": [0, 1], "linux": [0, 1], "window": [0, 1], "maco": 0, "m": 0, "pip": 0, "from": 0, "notifi": [0, 1], "import": 0, "titl": [0, 1], "test": 0, "messag": [0, 1], "icon": [0, 1], "custom": [0, 1], "us": [0, 1], "oper": 0, "choos": 0, "ani": [0, 1], "pre": 0, "defin": 0, "png": [0, 1], "file": [0, 1], "ico": [0, 1], "default": [0, 1], "destroi": [0, 1], "boolean": [0, 1], "valu": [0, 1], "box": 0, "after": 0, "debug": [0, 1], "displai": [0, 1], "log": [0, 1], "form": 0, "info": 0, "warn": 0, "error": [0, 1], "logger": [0, 1], "bring": [0, 1], "your": [0, 1], "own": [0, 1], "docstr": 0, "format": 0, "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "clean": 0, "commit": 0, "hook": 0, "flake8": 0, "isort": 0, "requir": 0, "changelog": 0, "gener": 0, "revers": 0, "f": 0, "release_not": 0, "rst": 0, "t": [0, 1], "precommit": 0, "ensur": 0, "doc": 0, "creation": 0, "ar": 0, "run": [0, 1], "everi": 0, "sphinx": 0, "5": 0, "1": 0, "recommonmark": 0, "all": 0, "http": 0, "org": 0, "project": 0, "thevickypedia": 0, "github": 0, "io": 0, "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "instal": 1, "usag": 1, "option": 1, "argument": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "pypi": 1, "packag": 1, "runbook": 1, "licens": 1, "copyright": 1, "o": 1, "agnost": 1, "pynotifi": 1, "default_logg": 1, "configur": 1, "return": 1, "object": 1, "an": 1, "type": 1, "anystr": 1, "union": 1, "str": 1, "pathlik": 1, "none": 1, "bool": 1, "fals": 1, "noreturn": 1, "paramet": 1, "ha": 1, "go": 1, "add": 1, "show": 1, "output": 1, "balloon": 1, "immedi": 1, "person": 1, "both": 1, "pleas": 1, "thi": 1, "doesn": 1, "guarante": 1, "pop": 1, "up": 1, "built": 1, "tool": 1, "how": 1, "i": 1, "sole": 1, "reli": 1, "set": 1, "windowso": 1, "binari": 1, "api": 1, "gui": 1, "windowsnotif": 1, "class": 1, "mod": 1, "windowsballoontip": 1, "msg": 1, "instanti": 1, "dedic": 1, "process": 1, "initi": 1, "assign": 1, "creat": 1, "member": 1, "receiv": 1, "fashion": 1, "send": 1, "tip": 1, "flag": 1, "wa": 1, "success": 1, "otherwis": 1, "string": 1, "on_destroi": 1, "arg": 1, "kwarg": 1, "keyword": 1, "lparam": 1, "hwnd": 1, "wparam": 1, "index": 1, "search": 1, "page": 1}, "objects": {"pynotification": [[1, 0, 0, "-", "mod"], [1, 0, 0, "-", "pynotifier"]], "pynotification.mod": [[1, 1, 1, "", "WindowsBalloonTip"]], "pynotification.mod.WindowsBalloonTip": [[1, 2, 1, "", "notify"], [1, 2, 1, "", "on_destroy"], [1, 2, 1, "", "run"]], "pynotification.pynotifier": [[1, 3, 1, "", "default_logger"], [1, 3, 1, "", "pynotifier"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "function", "Python function"]}, "titleterms": {"pynotif": [0, 1], "instal": 0, "usag": 0, "option": 0, "argument": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "welcom": 1, "": 1, "document": 1, "read": 1, "me": 1, "modul": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}})
\ No newline at end of file
diff --git a/notifier/__init__.py b/notifier/__init__.py
deleted file mode 100644
index b017c4e..0000000
--- a/notifier/__init__.py
+++ /dev/null
@@ -1,5 +0,0 @@
-"""Place holder for package."""
-
-from .notify import notify # noqa: F401
-
-version = "0.0.9"
diff --git a/pynotification/__init__.py b/pynotification/__init__.py
new file mode 100644
index 0000000..5264a21
--- /dev/null
+++ b/pynotification/__init__.py
@@ -0,0 +1,5 @@
+"""Place holder for package."""
+
+from .pynotifier import pynotifier # noqa: F401
+
+version = "0.1.0"
diff --git a/notifier/mod.py b/pynotification/mod.py
similarity index 100%
rename from notifier/mod.py
rename to pynotification/mod.py
diff --git a/notifier/notification.ico b/pynotification/notification.ico
similarity index 100%
rename from notifier/notification.ico
rename to pynotification/notification.ico
diff --git a/notifier/notify.py b/pynotification/pynotifier.py
similarity index 93%
rename from notifier/notify.py
rename to pynotification/pynotifier.py
index fbc23d8..431a5bd 100644
--- a/notifier/notify.py
+++ b/pynotification/pynotifier.py
@@ -26,8 +26,8 @@ def default_logger() -> logging.Logger:
# noinspection PyProtectedMember
-def notify(title: AnyStr, message: AnyStr, icon: Union[str, os.PathLike] = None,
- debug: bool = False, logger: logging.Logger = None, destroy: bool = False) -> NoReturn:
+def pynotifier(title: AnyStr, message: AnyStr, icon: Union[str, os.PathLike] = None,
+ debug: bool = False, logger: logging.Logger = None, destroy: bool = False) -> NoReturn:
"""Triggers a system notification.
Args:
diff --git a/pypi_upload.sh b/pypi_upload.sh
new file mode 100644
index 0000000..e365b06
--- /dev/null
+++ b/pypi_upload.sh
@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+# 'set -e' stops the execution of a script if a command or pipeline has an error.
+# This is the opposite of the default shell behaviour, which is to ignore errors in scripts.
+set -e
+
+echo -e "\nCleaning up existing pieces"
+rm -rf dist pynotification.egg-info
+
+echo -e "\nUpgrading pip"
+python -m pip install --upgrade pip
+
+echo -e "\nInstalling dependencies"
+pip install build twine
+
+echo -e "\nCreating package"
+python -m build
+
+echo -e "\nRunning twine check"
+twine check dist/*
+
+read -p "Are you sure you want to proceed uploading to pypi? " prompt
+if [[ $prompt =~ [yY](es)* ]]
+ then
+ echo -e "\nUploading to pypi"
+ twine upload dist/*.whl
+ else
+ echo -e "BUILD PROCESS TERMINATED\n"
+fi
diff --git a/pyproject.toml b/pyproject.toml
index 5f6142d..bdebe96 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -21,10 +21,10 @@ dependencies = [
]
[tool.setuptools]
-packages = ["notifier"]
+packages = ["pynotification"]
[tool.setuptools.dynamic]
-version = {attr = "notifier.version"}
+version = {attr = "pynotification.version"}
[build-system]
requires = ["setuptools", "wheel"]
diff --git a/release_notes.rst b/release_notes.rst
index 6b0976e..bcdd520 100644
--- a/release_notes.rst
+++ b/release_notes.rst
@@ -1,6 +1,11 @@
Release Notes
=============
+0.1.0 (01/10/2023)
+------------------
+- Restructure submodules and rename them to avoid conflict
+- Add more test cases and add pypi_upload.sh for local builds
+
0.0.9 (01/09/2023)
------------------
- Add options to include custom icons in notifications
diff --git a/tests/__init__.py b/tests/__init__.py
new file mode 100644
index 0000000..d363439
--- /dev/null
+++ b/tests/__init__.py
@@ -0,0 +1 @@
+"""Placeholder init module for tests."""
diff --git a/tests/test_notify.py b/tests/test_notify.py
index 89957f0..f9301cb 100644
--- a/tests/test_notify.py
+++ b/tests/test_notify.py
@@ -1,12 +1,27 @@
"""Unit test for module."""
-
+import logging
from unittest.mock import patch
-from notifier import notify
+from pynotification import builtin_notifier
+
+
+@patch("os.system")
+def test_builtin_notifier(mock_system):
+ """Run unit test on builtin_notifier."""
+ builtin_notifier(title="Test title", message="Test message")
+ mock_system.assert_called()
+
+
+@patch("os.system")
+def test_builtin_notifier_debug(mock_system):
+ """Run unit test on builtin_notifier with debug enabled."""
+ builtin_notifier(title="Test title", message="Test message", debug=True)
+ mock_system.assert_called()
@patch("os.system")
-def test_notify(mock_system):
- """Run unit test on notify."""
- notify(title="Test title", message="Test message")
+def test_builtin_notifier_logger(mock_system):
+ """Run unit test on builtin_notifier with debug enabled."""
+ logger = logging.getLogger(__name__)
+ builtin_notifier(title="Test title", message="Test message", debug=True, logger=logger)
mock_system.assert_called()
Notify¶
+PyNotification¶
Module to trigger OS agnostic notifications.
-
-
- -notifier.notify.default_logger() Logger¶ +
- +pynotification.pynotifier.default_logger() Logger¶
Configure default logger.
-
-
- -notifier.notify.notify(title: AnyStr, message: AnyStr, icon: Optional[Union[str, PathLike]] = None, debug: bool = False, logger: Optional[Logger] = None, destroy: bool = False) NoReturn¶ +
- +pynotification.pynotifier.pynotifier(title: AnyStr, message: AnyStr, icon: Optional[Union[str, PathLike]] = None, debug: bool = False, logger: Optional[Logger] = None, destroy: bool = False) NoReturn¶
Triggers a system notification.
Module¶
+Module¶
Module to trigger notifications in WindowsOS, using windows binaries for API and GUI.
>>> WindowsNotifications
-
-
- -class notifier.mod.WindowsBalloonTip(title: str, msg: str, icon: Union[str, PathLike], debug: bool, logger: Logger, destroy: bool)¶ +
- +class pynotification.mod.WindowsBalloonTip(title: str, msg: str, icon: Union[str, PathLike], debug: bool, logger: Logger, destroy: bool)¶
Instantiates WindowsBalloonTip object as a dedicated process to trigger notification in Windows OS.
@@ -144,14 +141,14 @@>>> WindowsBalloonTip
——–PyNotification——–
-
-
- -notify() Union[bool, str]¶ +
- +notify() Union[bool, str]¶
Run notification as balloon window tip.
-
-
- -on_destroy(*args, **kwargs) NoReturn¶ +
- +on_destroy(*args, **kwargs) NoReturn¶
Destroys the notification window created.
- Parameters: @@ -203,9 +200,8 @@
- Welcome to pynotification’s documentation! -
- ——–PyNotification——– -
- Notify -
- Module +
- PyNotification +
- Module
- Indices and tables
Indices and tablesTable of Contents
Navigation
Python Module Index
diff --git a/docs/searchindex.js b/docs/searchindex.js index 694e97b..8cc7ac3 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["PyNotification", "Welcome to pynotification\u2019s documentation!"], "terms": {"platform": 0, "support": [0, 1], "deploy": 0, "python": 0, "modul": 0, "trigger": [0, 1], "system": [0, 1], "notif": [0, 1], "linux": [0, 1], "window": [0, 1], "maco": 0, "m": 0, "pip": 0, "from": 0, "notifi": 0, "import": 0, "titl": [0, 1], "test": 0, "messag": [0, 1], "icon": [0, 1], "custom": [0, 1], "us": [0, 1], "oper": 0, "choos": 0, "ani": [0, 1], "pre": 0, "defin": 0, "png": [0, 1], "file": [0, 1], "ico": [0, 1], "default": [0, 1], "destroi": [0, 1], "boolean": [0, 1], "valu": [0, 1], "box": 0, "after": 0, "debug": [0, 1], "displai": [0, 1], "log": [0, 1], "form": 0, "info": 0, "warn": 0, "error": [0, 1], "logger": [0, 1], "bring": [0, 1], "your": [0, 1], "own": [0, 1], "docstr": 0, "format": 0, "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "clean": 0, "commit": 0, "hook": 0, "flake8": 0, "isort": 0, "requir": 0, "changelog": 0, "gener": 0, "revers": 0, "f": 0, "release_not": 0, "rst": 0, "t": [0, 1], "precommit": 0, "ensur": 0, "doc": 0, "creation": 0, "ar": 0, "run": [0, 1], "everi": 0, "sphinx": 0, "5": 0, "1": 0, "recommonmark": 0, "all": 0, "http": 0, "org": 0, "project": 0, "thevickypedia": 0, "github": 0, "io": 0, "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "instal": 1, "usag": 1, "option": 1, "argument": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "pypi": 1, "packag": 1, "runbook": 1, "licens": 1, "copyright": 1, "o": 1, "agnost": 1, "default_logg": 1, "configur": 1, "return": 1, "object": 1, "an": 1, "type": 1, "anystr": 1, "union": 1, "str": 1, "pathlik": 1, "none": 1, "bool": 1, "fals": 1, "noreturn": 1, "paramet": 1, "ha": 1, "go": 1, "add": 1, "show": 1, "output": 1, "balloon": 1, "immedi": 1, "person": 1, "both": 1, "pleas": 1, "thi": 1, "doesn": 1, "guarante": 1, "pop": 1, "up": 1, "built": 1, "tool": 1, "how": 1, "i": 1, "sole": 1, "reli": 1, "set": 1, "windowso": 1, "binari": 1, "api": 1, "gui": 1, "windowsnotif": 1, "class": 1, "mod": 1, "windowsballoontip": 1, "msg": 1, "instanti": 1, "dedic": 1, "process": 1, "initi": 1, "assign": 1, "creat": 1, "member": 1, "receiv": 1, "fashion": 1, "send": 1, "tip": 1, "flag": 1, "wa": 1, "success": 1, "otherwis": 1, "string": 1, "on_destroi": 1, "arg": 1, "kwarg": 1, "keyword": 1, "lparam": 1, "hwnd": 1, "wparam": 1, "index": 1, "search": 1, "page": 1}, "objects": {"notifier": [[1, 0, 0, "-", "mod"], [1, 0, 0, "-", "notify"]], "notifier.mod": [[1, 1, 1, "", "WindowsBalloonTip"]], "notifier.mod.WindowsBalloonTip": [[1, 2, 1, "", "notify"], [1, 2, 1, "", "on_destroy"], [1, 2, 1, "", "run"]], "notifier.notify": [[1, 3, 1, "", "default_logger"], [1, 3, 1, "", "notify"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "function", "Python function"]}, "titleterms": {"pynotif": [0, 1], "instal": 0, "usag": 0, "option": 0, "argument": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "welcom": 1, "": 1, "document": 1, "read": 1, "me": 1, "notifi": 1, "modul": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}}) \ No newline at end of file +Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["PyNotification", "Welcome to pynotification\u2019s documentation!"], "terms": {"platform": 0, "support": [0, 1], "deploy": 0, "python": 0, "modul": 0, "trigger": [0, 1], "system": [0, 1], "notif": [0, 1], "linux": [0, 1], "window": [0, 1], "maco": 0, "m": 0, "pip": 0, "from": 0, "notifi": [0, 1], "import": 0, "titl": [0, 1], "test": 0, "messag": [0, 1], "icon": [0, 1], "custom": [0, 1], "us": [0, 1], "oper": 0, "choos": 0, "ani": [0, 1], "pre": 0, "defin": 0, "png": [0, 1], "file": [0, 1], "ico": [0, 1], "default": [0, 1], "destroi": [0, 1], "boolean": [0, 1], "valu": [0, 1], "box": 0, "after": 0, "debug": [0, 1], "displai": [0, 1], "log": [0, 1], "form": 0, "info": 0, "warn": 0, "error": [0, 1], "logger": [0, 1], "bring": [0, 1], "your": [0, 1], "own": [0, 1], "docstr": 0, "format": 0, "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "clean": 0, "commit": 0, "hook": 0, "flake8": 0, "isort": 0, "requir": 0, "changelog": 0, "gener": 0, "revers": 0, "f": 0, "release_not": 0, "rst": 0, "t": [0, 1], "precommit": 0, "ensur": 0, "doc": 0, "creation": 0, "ar": 0, "run": [0, 1], "everi": 0, "sphinx": 0, "5": 0, "1": 0, "recommonmark": 0, "all": 0, "http": 0, "org": 0, "project": 0, "thevickypedia": 0, "github": 0, "io": 0, "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "instal": 1, "usag": 1, "option": 1, "argument": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "pypi": 1, "packag": 1, "runbook": 1, "licens": 1, "copyright": 1, "o": 1, "agnost": 1, "pynotifi": 1, "default_logg": 1, "configur": 1, "return": 1, "object": 1, "an": 1, "type": 1, "anystr": 1, "union": 1, "str": 1, "pathlik": 1, "none": 1, "bool": 1, "fals": 1, "noreturn": 1, "paramet": 1, "ha": 1, "go": 1, "add": 1, "show": 1, "output": 1, "balloon": 1, "immedi": 1, "person": 1, "both": 1, "pleas": 1, "thi": 1, "doesn": 1, "guarante": 1, "pop": 1, "up": 1, "built": 1, "tool": 1, "how": 1, "i": 1, "sole": 1, "reli": 1, "set": 1, "windowso": 1, "binari": 1, "api": 1, "gui": 1, "windowsnotif": 1, "class": 1, "mod": 1, "windowsballoontip": 1, "msg": 1, "instanti": 1, "dedic": 1, "process": 1, "initi": 1, "assign": 1, "creat": 1, "member": 1, "receiv": 1, "fashion": 1, "send": 1, "tip": 1, "flag": 1, "wa": 1, "success": 1, "otherwis": 1, "string": 1, "on_destroi": 1, "arg": 1, "kwarg": 1, "keyword": 1, "lparam": 1, "hwnd": 1, "wparam": 1, "index": 1, "search": 1, "page": 1}, "objects": {"pynotification": [[1, 0, 0, "-", "mod"], [1, 0, 0, "-", "pynotifier"]], "pynotification.mod": [[1, 1, 1, "", "WindowsBalloonTip"]], "pynotification.mod.WindowsBalloonTip": [[1, 2, 1, "", "notify"], [1, 2, 1, "", "on_destroy"], [1, 2, 1, "", "run"]], "pynotification.pynotifier": [[1, 3, 1, "", "default_logger"], [1, 3, 1, "", "pynotifier"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "function", "Python function"]}, "titleterms": {"pynotif": [0, 1], "instal": 0, "usag": 0, "option": 0, "argument": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "welcom": 1, "": 1, "document": 1, "read": 1, "me": 1, "modul": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}}) \ No newline at end of file diff --git a/notifier/__init__.py b/notifier/__init__.py deleted file mode 100644 index b017c4e..0000000 --- a/notifier/__init__.py +++ /dev/null @@ -1,5 +0,0 @@ -"""Place holder for package.""" - -from .notify import notify # noqa: F401 - -version = "0.0.9" diff --git a/pynotification/__init__.py b/pynotification/__init__.py new file mode 100644 index 0000000..5264a21 --- /dev/null +++ b/pynotification/__init__.py @@ -0,0 +1,5 @@ +"""Place holder for package.""" + +from .pynotifier import pynotifier # noqa: F401 + +version = "0.1.0" diff --git a/notifier/mod.py b/pynotification/mod.py similarity index 100% rename from notifier/mod.py rename to pynotification/mod.py diff --git a/notifier/notification.ico b/pynotification/notification.ico similarity index 100% rename from notifier/notification.ico rename to pynotification/notification.ico diff --git a/notifier/notify.py b/pynotification/pynotifier.py similarity index 93% rename from notifier/notify.py rename to pynotification/pynotifier.py index fbc23d8..431a5bd 100644 --- a/notifier/notify.py +++ b/pynotification/pynotifier.py @@ -26,8 +26,8 @@ def default_logger() -> logging.Logger: # noinspection PyProtectedMember -def notify(title: AnyStr, message: AnyStr, icon: Union[str, os.PathLike] = None, - debug: bool = False, logger: logging.Logger = None, destroy: bool = False) -> NoReturn: +def pynotifier(title: AnyStr, message: AnyStr, icon: Union[str, os.PathLike] = None, + debug: bool = False, logger: logging.Logger = None, destroy: bool = False) -> NoReturn: """Triggers a system notification. Args: diff --git a/pypi_upload.sh b/pypi_upload.sh new file mode 100644 index 0000000..e365b06 --- /dev/null +++ b/pypi_upload.sh @@ -0,0 +1,28 @@ +#!/usr/bin/env bash +# 'set -e' stops the execution of a script if a command or pipeline has an error. +# This is the opposite of the default shell behaviour, which is to ignore errors in scripts. +set -e + +echo -e "\nCleaning up existing pieces" +rm -rf dist pynotification.egg-info + +echo -e "\nUpgrading pip" +python -m pip install --upgrade pip + +echo -e "\nInstalling dependencies" +pip install build twine + +echo -e "\nCreating package" +python -m build + +echo -e "\nRunning twine check" +twine check dist/* + +read -p "Are you sure you want to proceed uploading to pypi?- n + p - notifier+ pynotification- notifier.mod+ pynotification.mod- notifier.notify+ pynotification.pynotifier" prompt +if [[ $prompt =~ [yY](es)* ]] + then + echo -e "\nUploading to pypi" + twine upload dist/*.whl + else + echo -e "BUILD PROCESS TERMINATED\n" +fi diff --git a/pyproject.toml b/pyproject.toml index 5f6142d..bdebe96 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -21,10 +21,10 @@ dependencies = [ ] [tool.setuptools] -packages = ["notifier"] +packages = ["pynotification"] [tool.setuptools.dynamic] -version = {attr = "notifier.version"} +version = {attr = "pynotification.version"} [build-system] requires = ["setuptools", "wheel"] diff --git a/release_notes.rst b/release_notes.rst index 6b0976e..bcdd520 100644 --- a/release_notes.rst +++ b/release_notes.rst @@ -1,6 +1,11 @@ Release Notes ============= +0.1.0 (01/10/2023) +------------------ +- Restructure submodules and rename them to avoid conflict +- Add more test cases and add pypi_upload.sh for local builds + 0.0.9 (01/09/2023) ------------------ - Add options to include custom icons in notifications diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..d363439 --- /dev/null +++ b/tests/__init__.py @@ -0,0 +1 @@ +"""Placeholder init module for tests.""" diff --git a/tests/test_notify.py b/tests/test_notify.py index 89957f0..f9301cb 100644 --- a/tests/test_notify.py +++ b/tests/test_notify.py @@ -1,12 +1,27 @@ """Unit test for module.""" - +import logging from unittest.mock import patch -from notifier import notify +from pynotification import builtin_notifier + + +@patch("os.system") +def test_builtin_notifier(mock_system): + """Run unit test on builtin_notifier.""" + builtin_notifier(title="Test title", message="Test message") + mock_system.assert_called() + + +@patch("os.system") +def test_builtin_notifier_debug(mock_system): + """Run unit test on builtin_notifier with debug enabled.""" + builtin_notifier(title="Test title", message="Test message", debug=True) + mock_system.assert_called() @patch("os.system") -def test_notify(mock_system): - """Run unit test on notify.""" - notify(title="Test title", message="Test message") +def test_builtin_notifier_logger(mock_system): + """Run unit test on builtin_notifier with debug enabled.""" + logger = logging.getLogger(__name__) + builtin_notifier(title="Test title", message="Test message", debug=True, logger=logger) mock_system.assert_called()
