{"id":18950053,"url":"https://github.com/salesforce/pixnotify","last_synced_at":"2025-04-15T23:31:38.391Z","repository":{"id":66001705,"uuid":"242198482","full_name":"salesforce/piXnotify","owner":"salesforce","description":"This project is an attempt to build a cross-platform notification library in python.","archived":false,"fork":false,"pushed_at":"2023-03-27T19:20:30.000Z","size":23,"stargazers_count":1,"open_issues_count":3,"forks_count":3,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-04-08T00:13:11.516Z","etag":null,"topics":["linux","macos","notification-service","notifications","python","windows-10"],"latest_commit_sha":null,"homepage":"","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/salesforce.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null}},"created_at":"2020-02-21T17:50:17.000Z","updated_at":"2021-10-19T17:49:03.000Z","dependencies_parsed_at":"2023-09-24T16:40:14.896Z","dependency_job_id":null,"html_url":"https://github.com/salesforce/piXnotify","commit_stats":{"total_commits":10,"total_committers":3,"mean_commits":"3.3333333333333335","dds":"0.19999999999999996","last_synced_commit":"259e967f41858330acac1b94e856b0284bc21d1f"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salesforce%2FpiXnotify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salesforce%2FpiXnotify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salesforce%2FpiXnotify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salesforce%2FpiXnotify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/salesforce","download_url":"https://codeload.github.com/salesforce/piXnotify/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223689751,"owners_count":17186491,"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":["linux","macos","notification-service","notifications","python","windows-10"],"created_at":"2024-11-08T13:20:30.489Z","updated_at":"2025-04-15T23:31:38.379Z","avatar_url":"https://github.com/salesforce.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# piXnotify\n\nThis project is an attempt to build a cross-platform notification library in python.\n\nIt heavily relies on platform-dependant notification libraries, namely \n\n- [pync](https://github.com/SeTeM/pync)\n- [notify2](https://notify2.readthedocs.io/en/latest/)\n- [win10toast](https://pypi.org/project/win10toast/)\n\nYou could also use [plyer](https://github.com/kivy/plyer/tree/master/plyer) project which aims to provide a whole set of cross platform features such as notifications, camera manipulation ...\n\n## Setup\n\nRun \n```\npip install .\n``` \nor \n```\npython setup.py sdist\npython setup.py install\n```\n\nThis will install platform-specific python packages, specified in python.py .\n\n## Usage\n\nTypical package usage will be:\n\n```\nfrom piXnotify import notifier\n\nnotifier.set_title(\"Title\").set_message(\"message\").notify()\n```\n\nAvailable options are:\n- set_title\n- set_message\n- set_app_icon (WIP)\n- set_activate (WIP)\n- set_url (WIP)\n- set_group (WIP)\n- set_sound (WIP)\n- set_execute (WIP)\n\nAs you can see, a lot of these are still WIP. This is mainly because of OS specific behaviours that have not been extensively tested yet. \n\n## System Specific Usages\n\n### MacOs\n\nOn Mac systems, if no notifications get displayed:\n- Make sure you are not in \"focus mode\"\n- Make sure terminal-notifier has notifications enabled (System Settings \u003e Notifications \u003e terminal-notifier \u003e Allow notifications)\n\n## Development and contributions\n\nContributions are encouraged, please use Issues to communicate on improvements you may be working on. \n\nIn order to accept your pull request, we need you to submit a CLA. You only need to do this once, so if you've done this for another Salesforce open source project, you're good to go. If you are submitting a pull request for the first time, just let us know that you have completed the CLA and we can cross-check with your GitHub username.\n\n[Complete your CLA here](https://cla.salesforce.com/sign-cla).\n\nCode must be formatted with [black](https://pypi.org/project/black/). You can reformat all code before submission with this command: `black .` .\n\n## Code of conduct\n\nSalesforce open-source projects are committed to providing a friendly, safe, and welcoming environment for all. \n\nYou may read more in the [Code of Conduct](./CODE_OF_CONDUCT.md).\n\nThe goal of this code of conduct is to specify a baseline standard of behavior so that people with different social values and communication styles can work together effectively, productively, and respectfully in our open source community. It also establishes a mechanism for reporting issues and resolving conflicts.\n\nAll questions and reports of abusive, harassing, or otherwise unacceptable behavior in a Salesforce open-source project may be reported by contacting the Salesforce Open Source Conduct Committee at ossconduct@salesforce.com.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsalesforce%2Fpixnotify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsalesforce%2Fpixnotify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsalesforce%2Fpixnotify/lists"}