{"id":22316700,"url":"https://github.com/developerstoolbox/notify-package","last_synced_at":"2026-01-18T22:02:14.991Z","repository":{"id":241185556,"uuid":"804560820","full_name":"DevelopersToolbox/notify-package","owner":"DevelopersToolbox","description":"Provides a set of utility functions for printing formatted messages to the terminal","archived":false,"fork":false,"pushed_at":"2025-10-27T04:56:36.000Z","size":252,"stargazers_count":1,"open_issues_count":10,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-27T06:24:23.982Z","etag":null,"topics":["error","information","notify","success","system","warning","wolfsoftware"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DevelopersToolbox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["WolfSoftware","TGWolf"]}},"created_at":"2024-05-22T20:27:00.000Z","updated_at":"2025-10-27T04:49:00.000Z","dependencies_parsed_at":"2024-05-22T22:28:48.511Z","dependency_job_id":"5261a5ef-f2b7-4dff-8de3-4472b6b094ea","html_url":"https://github.com/DevelopersToolbox/notify-package","commit_stats":null,"previous_names":["developerstoolbox/notify-package"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/DevelopersToolbox/notify-package","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevelopersToolbox%2Fnotify-package","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevelopersToolbox%2Fnotify-package/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevelopersToolbox%2Fnotify-package/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevelopersToolbox%2Fnotify-package/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DevelopersToolbox","download_url":"https://codeload.github.com/DevelopersToolbox/notify-package/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevelopersToolbox%2Fnotify-package/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28552130,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T20:59:07.572Z","status":"ssl_error","status_checked_at":"2026-01-18T20:59:02.799Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["error","information","notify","success","system","warning","wolfsoftware"],"created_at":"2024-12-03T23:07:33.965Z","updated_at":"2026-01-18T22:02:14.974Z","avatar_url":"https://github.com/DevelopersToolbox.png","language":"Python","readme":"\u003c!-- markdownlint-disable --\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/DevelopersToolbox/\"\u003e\n        \u003cimg src=\"https://cdn.wolfsoftware.com/assets/images/github/organisations/developerstoolbox/black-and-white-circle-256.png\" alt=\"DevelopersToolbox logo\" /\u003e\n    \u003c/a\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/DevelopersToolbox/notify-package/actions/workflows/cicd.yml\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/DevelopersToolbox/notify-package/cicd.yml?branch=master\u0026label=build%20status\u0026style=for-the-badge\" alt=\"Github Build Status\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/DevelopersToolbox/notify-package/blob/master/LICENSE.md\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/license/DevelopersToolbox/notify-package?color=blue\u0026label=License\u0026style=for-the-badge\" alt=\"License\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/DevelopersToolbox/notify-package\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/created-at/DevelopersToolbox/notify-package?color=blue\u0026label=Created\u0026style=for-the-badge\" alt=\"Created\"\u003e\n    \u003c/a\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/DevelopersToolbox/notify-package/releases/latest\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/v/release/DevelopersToolbox/notify-package?color=blue\u0026label=Latest%20Release\u0026style=for-the-badge\" alt=\"Release\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/DevelopersToolbox/notify-package/releases/latest\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/release-date/DevelopersToolbox/notify-package?color=blue\u0026label=Released\u0026style=for-the-badge\" alt=\"Released\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/DevelopersToolbox/notify-package/releases/latest\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/commits-since/DevelopersToolbox/notify-package/latest.svg?color=blue\u0026style=for-the-badge\" alt=\"Commits since release\"\u003e\n    \u003c/a\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/DevelopersToolbox/notify-package/blob/master/.github/CODE_OF_CONDUCT.md\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Code%20of%20Conduct-blue?style=for-the-badge\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/DevelopersToolbox/notify-package/blob/master/.github/CONTRIBUTING.md\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Contributing-blue?style=for-the-badge\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/DevelopersToolbox/notify-package/blob/master/.github/SECURITY.md\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Report%20Security%20Concern-blue?style=for-the-badge\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/DevelopersToolbox/notify-package/issues\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Get%20Support-blue?style=for-the-badge\" /\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n## Overview\n\nThe Notify package provides a set of utility functions for printing formatted messages to the terminal. The main purpose of this\nmodule is to facilitate the display of success, warning, error, informational, and system messages with specific color and style\nformatting using predefined constants.\n\n## Features\n\n- Display success messages with green text.\n- Display warning messages with yellow text.\n- Display error messages with red text.\n- Display informational messages with cyan text.\n- Display system messages with grey text.\n- Support for custom colors, prompts, and formatting scopes.\n- Error handling for invalid colors and scopes.\n\n## Installation\n\nTo install the Notify package, use the following command:\n\n```bash\npip install wolfsoftware.notify\n```\n\n## Usage\n\nHere is an example of how to use the notification functions provided by the Notify package:\n\n```python\nfrom wolfsoftware.notify import success_message, warning_message, error_message, info_message, system_message\n\nprint(success_message(\"Operation completed successfully.\"))\nprint(warning_message(\"This is a warning message.\"))\nprint(error_message(\"An error occurred.\"))\nprint(info_message(\"This is some information.\"))\nprint(system_message(\"System update available.\"))\n```\n\n## Functions\n\n### `success_message`\n\nPrint a success message with a specific format.\n\n```python\ndef success_message(\n        message: str,\n        color: str = 'green+bold',\n        prompt: str = 'Success',\n        scope: str = 'prompt_text',\n        prompt_prefix: str = '[ ',\n        prompt_suffix: str = ' ]'\n    ) -\u003e str:\n```\n\n### `warning_message`\n\nPrint a warning message with a specific format.\n\n```python\ndef warning_message(\n        message: str,\n        color: str = 'yellow+bold',\n        prompt: str = 'Warning',\n        scope: str = 'prompt_text',\n        prompt_prefix: str = '[ ',\n        prompt_suffix: str = ' ]'\n    ) -\u003e str:\n```\n\n### `error_message`\n\nPrint an error message with a specific format.\n\n```python\ndef error_message(\n        message: str,\n        color: str = 'red+bold',\n        prompt: str = 'Error',\n        scope: str = 'prompt_text',\n        prompt_prefix: str = '[ ',\n        prompt_suffix: str = ' ]'\n    ) -\u003e str:\n```\n\n### `failure_message`\n\nAlias for `error_message`, but with a prompt='Failure'.\n\n```python\nfailure_message = error_message\n```\n\n### `info_message`\n\nPrint an informational message with a specific format.\n\n```python\ndef info_message(\n        message: str,\n        color: str = 'cyan+bold',\n        prompt: str = 'Info',\n        scope: str = 'prompt_text',\n        prompt_prefix: str = '[ ',\n        prompt_suffix: str = ' ]'\n    ) -\u003e str:\n```\n\n### `system_message`\n\nPrint a system message with a specific format.\n\n```python\ndef system_message(\n        message: str,\n        color: str = 'grey+bold',\n        prompt: str = 'System',\n        scope: str = 'prompt_text',\n        prompt_prefix: str = '[ ',\n        prompt_suffix: str = ' ]'\n    ) -\u003e str:\n```\n\n## Customization\n\nYou can customize the color, prompt text, and the scope of the color application using the provided parameters. Here are some examples:\n\n### Custom Colors\n\n```python\nprint(success_message(\"Operation completed successfully.\", color=\"blue+bold\"))\n```\n\n### Custom Prompts\n\n```python\nprint(success_message(\"Operation completed successfully.\", prompt=\"Completed\"))\n```\n\n### Custom Scopes\n\n- `all`: Applies the color to the entire message.\n- `prompt`: Applies the color to the prompt only.\n- `prompt_text`: Applies the color to the text inside the brackets.\n\n```python\nprint(success_message(\"Operation completed successfully.\", scope=\"prompt\"))\nprint(success_message(\"Operation completed successfully.\", scope=\"prompt_text\"))\n```\n\n### Custom Prefixes and Suffixes\n\nYou can also customize the prompt prefix and suffix.\n\n```python\nprint(success_message(\"Operation completed successfully.\", prompt_prefix=\"\u003c\u003c\", prompt_suffix=\"\u003e\u003e\"))\n```\n\n## Error Handling\n\nThe Notify package includes error handling for invalid color and scope inputs. If an invalid color or scope is provided, a `NotifyValueError` will be raised with an appropriate error message.\n\n```python\nfrom wolfsoftware.notify import NotifyValueError\n\ntry:\n    print(success_message(\"Operation completed successfully.\", color=\"invalid\"))\nexcept NotifyValueError as e:\n    print(f\"Error: {e}\")\n```\n\n## Testing\n\nThe Notify package includes a comprehensive test suite to ensure the correct functionality of all message formatting functions. The tests verify that the package version is defined, the message functions return correctly formatted strings, and exceptions are raised appropriately for invalid inputs.\n\n### Running Tests\n\nTo run the tests, use a testing framework such as pytest:\n\n```bash\npytest tests/test_notify.py\n```\n\n## Acknowledgements\n\nThe Notify package uses the `colorama` library for cross-platform support of ANSI color codes. Many thanks to the contributors of the `colorama` project for their excellent work.\n\n\u003cbr /\u003e\n\u003cp align=\"right\"\u003e\u003ca href=\"https://wolfsoftware.com/\"\u003e\u003cimg src=\"https://img.shields.io/badge/Created%20by%20Wolf%20on%20behalf%20of%20Wolf%20Software-blue?style=for-the-badge\" /\u003e\u003c/a\u003e\u003c/p\u003e\n","funding_links":["https://github.com/sponsors/WolfSoftware","https://github.com/sponsors/TGWolf"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeveloperstoolbox%2Fnotify-package","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeveloperstoolbox%2Fnotify-package","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeveloperstoolbox%2Fnotify-package/lists"}