{"id":18022046,"url":"https://github.com/acifani/update-notipy","last_synced_at":"2025-06-30T10:34:09.765Z","repository":{"id":31313880,"uuid":"127526637","full_name":"acifani/update-notipy","owner":"acifani","description":"📬 Send a notification when there is an update available for your package","archived":false,"fork":false,"pushed_at":"2022-12-08T09:34:20.000Z","size":23,"stargazers_count":3,"open_issues_count":3,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-10T13:49:24.276Z","etag":null,"topics":["notifier","python","python-library","updater"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/update-notipy/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/acifani.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-31T11:35:13.000Z","updated_at":"2021-06-29T15:02:05.000Z","dependencies_parsed_at":"2023-01-14T18:46:51.435Z","dependency_job_id":null,"html_url":"https://github.com/acifani/update-notipy","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/acifani/update-notipy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acifani%2Fupdate-notipy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acifani%2Fupdate-notipy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acifani%2Fupdate-notipy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acifani%2Fupdate-notipy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/acifani","download_url":"https://codeload.github.com/acifani/update-notipy/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acifani%2Fupdate-notipy/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262756401,"owners_count":23359515,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["notifier","python","python-library","updater"],"created_at":"2024-10-30T06:11:52.445Z","updated_at":"2025-06-30T10:34:09.722Z","avatar_url":"https://github.com/acifani.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"📬 update-notipy\n================\n\nSend a notification when there is an update available for your package!\nPy-port of `update-notifier \u003chttps://github.com/yeoman/update-notifier\u003e`_.\n\n\nInstall\n-------\n\n``pipenv install update_notipy``\n\nor\n\n``pip install update_notipy``\n\nUsage\n-----\n\n.. code-block:: python\n\n    from update_notipy import update_notify\n\n    update_notify(\n        \u003cpkg_name\u003e,\n        \u003cpkg_version\u003e,\n        callback=\u003ccallback\u003e,\n        message=\u003cmessage\u003e,\n        defer=\u003cTrue|False\u003e).notify()\n\nArguments\n~~~~~~~~~\n\n- ``pkg_name: str``: name of the package as registered on PyPI\n- ``pkg_version: str``: version of the installed package, to be compared with the latest one\n- ``callback: Callable``: function to be called instead of printing the standard message\n- ``message: str``: custom message to be printed\n- ``defer: bool``: set to ``True`` if you want to notify the user when the app closes\n\nExamples\n--------\n\n.. code-block:: python\n\n    from update_notipy import update_notify\n\n    __version__ = \"0.1.0\"\n\n    update_notify('pkg-info', __version__).notify()\n\n    #    ┌───────────────────────────────────────────┐\n    #    │                                           │\n    #    │   Update available 0.1.0 → 0.1.2          │\n    #    │   Run pip install -U pkg-info to update   │\n    #    │                                           │\n    #    └───────────────────────────────────────────┘\n\n    def foo():\n        four = 2 + 2\n        print(four)\n\n    update_notify('pkg-info', __version__, callback=foo).notify()\n\n    # 4\n\n    update_notify('pkg-info', __version__, message=\"Hello, world!\").notify()\n\n    # Hello, world!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facifani%2Fupdate-notipy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Facifani%2Fupdate-notipy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facifani%2Fupdate-notipy/lists"}