# PyNotifyYou
**Attention**! I'm **far from the most experienced or smart developer**, so I'm **not denying** that my code can be pretty bad! I will **always** be glad to receive your **advice on improving the code** and **ideas** for implementation.
I also want to say that this is my first library, and most likely I will use quite a lot of old and crooked nonsense. Please don't blame me for this 👻
# Navigation
Let's add some convenience for navigating through the repository:
- [☁️Welcome☁️](#PyNotifyYou)
- [🧭Navigation🧭](#Navigation)
- [🐍 Providers 🐍](#Providers)
- [🔨Installing🔨](#Installing)
- [✅Usage✅](#PyNotifyYou)
# Providers
I plan to implement support for several ways to receive notifications, and I will simply call them providers for convenience. 👌
**At the moment**, the project supports only one provider: **Ntfy.sh**
# Installing
Okay, let's move on to the installation! In fact, the installation is no different from other libraries
You just need to install the library via pip:
```shell
pip install py-notify-you
```
# Usage
And here it 's more interesting!
You can see the simplest option for sending notifications below:
To receive notifications, you must install the [Ntfy app](https://play.google.com/store/apps/details?id=io.heckel.ntfy&pli=1) on your phone!
Then click on the "+" button in the lower right corner to create a topic and get link (It will be needed in the future)
When creating, you will be required to enter the name of the topic, which will be a link, for example:
- The link Topic with the name PyNotifyMe will look like this - https://ntfy.sh/PyNotifyMe
- The link Topic with the name PythonStore will look like this - https://ntfy.sh/PythonStore
Now all that remains is to write the code! For the easiest way to send notifications, you can use the code below:
```python
import PyNotifyYou
sender = PyNotifyYou.Ntfy("https://ntfy.sh/YourLink") # Here you should replace the link with your own
sender.send('Your message!')
```
**DON'T FORGET TO CHANGE THE LINK**
Также вы можете добавить заголовок для вашего уведомления используя метод ```set_title()``` :
```python
import PyNotifyYou
sender = PyNotifyYou.Ntfy("https://ntfy.sh/YourLink") # Here you should replace the link with your own
sender.send("Your title")
sender.send('Your message!')
```
Raw data
{
"_id": null,
"home_page": "https://github.com/shizamuru-dev/PyNotifyYou",
"name": "PyNotifyYou",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "notification,push,ntfy",
"author": "Shizamuru",
"author_email": "mmihajlov534@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/08/3a/acc8597a64b149cd7d54cc81a2204fb2cbd35e25249c900cdec2a0bd4a73/pynotifyyou-0.1.0.tar.gz",
"platform": null,
"description": "# PyNotifyYou\n\n\n**Attention**! I'm **far from the most experienced or smart developer**, so I'm **not denying** that my code can be pretty bad! I will **always** be glad to receive your **advice on improving the code** and **ideas** for implementation.\n\nI also want to say that this is my first library, and most likely I will use quite a lot of old and crooked nonsense. Please don't blame me for this \ud83d\udc7b\n\n# Navigation\n\nLet's add some convenience for navigating through the repository:\n\n - [\u2601\ufe0fWelcome\u2601\ufe0f](#PyNotifyYou)\n - [\ud83e\uddedNavigation\ud83e\udded](#Navigation)\n - [\ud83d\udc0d Providers \ud83d\udc0d](#Providers)\n - [\ud83d\udd28Installing\ud83d\udd28](#Installing)\n - [\u2705Usage\u2705](#PyNotifyYou)\n\n\n# Providers\nI plan to implement support for several ways to receive notifications, and I will simply call them providers for convenience. \ud83d\udc4c\n\n**At the moment**, the project supports only one provider: **Ntfy.sh**\n\n# Installing\n\nOkay, let's move on to the installation! In fact, the installation is no different from other libraries\n\nYou just need to install the library via pip:\n```shell\npip install py-notify-you\n```\n\n\n# Usage\n\nAnd here it 's more interesting!\n\nYou can see the simplest option for sending notifications below:\n\nTo receive notifications, you must install the [Ntfy app](https://play.google.com/store/apps/details?id=io.heckel.ntfy&pli=1) on your phone!\n\nThen click on the \"+\" button in the lower right corner to create a topic and get link (It will be needed in the future)\n\nWhen creating, you will be required to enter the name of the topic, which will be a link, for example:\n- The link Topic with the name PyNotifyMe will look like this - https://ntfy.sh/PyNotifyMe\n- The link Topic with the name PythonStore will look like this - https://ntfy.sh/PythonStore\n\n\nNow all that remains is to write the code! For the easiest way to send notifications, you can use the code below:\n```python\nimport PyNotifyYou\n\nsender = PyNotifyYou.Ntfy(\"https://ntfy.sh/YourLink\") # Here you should replace the link with your own\nsender.send('Your message!')\n```\n**DON'T FORGET TO CHANGE THE LINK**\n\n\n\u0422\u0430\u043a\u0436\u0435 \u0432\u044b \u043c\u043e\u0436\u0435\u0442\u0435 \u0434\u043e\u0431\u0430\u0432\u0438\u0442\u044c \u0437\u0430\u0433\u043e\u043b\u043e\u0432\u043e\u043a \u0434\u043b\u044f \u0432\u0430\u0448\u0435\u0433\u043e \u0443\u0432\u0435\u0434\u043e\u043c\u043b\u0435\u043d\u0438\u044f \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u044f \u043c\u0435\u0442\u043e\u0434 ```set_title()``` :\n\n```python\nimport PyNotifyYou\n\nsender = PyNotifyYou.Ntfy(\"https://ntfy.sh/YourLink\") # Here you should replace the link with your own\nsender.send(\"Your title\")\nsender.send('Your message!')\n```\n\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "'A simple library for sending notifications",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/shizamuru-dev/PyNotifyYou"
},
"split_keywords": [
"notification",
"push",
"ntfy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8449f845a0526cfcc4ff4fb197fcd7feb08063f44d286b0f28de49ff9872c2b0",
"md5": "1a373755593e6b90495f0173d0e603b0",
"sha256": "7e4cf8be7fbd5f71130d7a8023b50f1da5b5013df4c4191602dad690dcdbc176"
},
"downloads": -1,
"filename": "pynotifyyou-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a373755593e6b90495f0173d0e603b0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 3212,
"upload_time": "2024-02-25T05:52:34",
"upload_time_iso_8601": "2024-02-25T05:52:34.050137Z",
"url": "https://files.pythonhosted.org/packages/84/49/f845a0526cfcc4ff4fb197fcd7feb08063f44d286b0f28de49ff9872c2b0/pynotifyyou-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "083aacc8597a64b149cd7d54cc81a2204fb2cbd35e25249c900cdec2a0bd4a73",
"md5": "0e85f27c5044ed55405e5d6c85fb21e0",
"sha256": "efbdaa1e1aeec09c5a2b54f81b6b0597e0a00be2cb249145b755c194e36ce4e9"
},
"downloads": -1,
"filename": "pynotifyyou-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "0e85f27c5044ed55405e5d6c85fb21e0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 2892,
"upload_time": "2024-02-25T05:52:36",
"upload_time_iso_8601": "2024-02-25T05:52:36.127105Z",
"url": "https://files.pythonhosted.org/packages/08/3a/acc8597a64b149cd7d54cc81a2204fb2cbd35e25249c900cdec2a0bd4a73/pynotifyyou-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-25 05:52:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "shizamuru-dev",
"github_project": "PyNotifyYou",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pynotifyyou"
}
JSON
