A simple library for sending notifications
Project description
PyNotifyYou
A simple library for sending notifications
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:
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:
pip install py_notify_you
Usage
And here it 's more interesting!
You can see the simplest option for sending notifications below.
Since the example uses Ntfy you need to perform the following steps:
To receive notifications, you must install the Ntfy app on your phone(Android,IOS) or install PWA!
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:
import py_notify_you
sender = py_notify_you.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
You can also add a header for your notification using the method set_title()
:
import py_notify_you
sender = py_notify_you.Ntfy("https://ntfy.sh/YourLink") # Here you should replace the link with your own
sender.set_title("Your title")
sender.send_template('Your message!')
More information can be found on the project's wiki
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file py_notify_you-1.0.7.tar.gz
.
File metadata
- Download URL: py_notify_you-1.0.7.tar.gz
- Upload date:
- Size: 4.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.3 Windows/11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 369d801a11cd8b9dd77630d155ae8d4a6afb4c7464ee6b004998be633406e926 |
|
MD5 | 9a7d75a500905a923cf2bc0e70e61569 |
|
BLAKE2b-256 | 0fc26f4f185ef3ba65a4714f247c3f8f8c7753f067968d472e858f110bcc04dd |
File details
Details for the file py_notify_you-1.0.7-py3-none-any.whl
.
File metadata
- Download URL: py_notify_you-1.0.7-py3-none-any.whl
- Upload date:
- Size: 5.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.3 Windows/11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 58f50e3d4d1ceefabf06accde2e46088f745031bafb690c311e0477a65192a63 |
|
MD5 | 5f17c25f74a9ba44ecbff46a209eab99 |
|
BLAKE2b-256 | d82be5a26982728afb0deadbdcec96a78786e9dea91817fe64a5273384bd6522 |