| Name | NotifPy JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | https://github.com/ArianFotouhi |
| Summary | NotifPy is here to send alert, notification and promotion related email and SMS |
| upload_time | 2023-08-03 21:07:48 |
| maintainer | |
| docs_url | None |
| author | Arian |
| requires_python | >=3.7 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# NotifPy
Available on https://pypi.org/project/NotifPy/
NotifPy is an all-in-one Python package designed to enable users to effortlessly send email and SMS notifications or alerts to designated email addresses and phone numbers. With NotifPy, integrating robust email and SMS functionalities into applications becomes seamless, facilitating prompt communication with target audiences.
Start Using NotifPy by
```bash
pip install NotifPy
```
To employ email services follow the below steps:
```python
from NotifPy import EmailNotif
sender = EmailNotif.email_notif(sender_address='A@B.com', sender_password='your_email_password', recipient_email='B@C.com')
sender.EmailSender(subject = "It's me! Hi!", body='This is a test')
```
It is noteworthy, the default email service provider of package is gmail while simply it can be configured to yahoo, outlook/hotmail and the customized mode:
```python
sender.EmailSender(subject = "It's me! Hi!", body='This is a test', email_provider='yahoo')
sender.EmailSender(subject = "It's me! Hi!", body='This is a test', email_provider='outlook')
```
For customized mode, it can be set based on SMTP server and port of your choice. For instance, for AOL mail:
```python
sender.EmailSender(subject = "It's me! Hi!", body='This is a test', email_provider='', custom_server='smtp.aol.com', custom_port=587)
```
Furthermore, to use gmail service, due to recent Google policy, you need to first activate 2-step verfication then generate a 16-character app password for your email and use that password here. [Google App Password](https://support.google.com/accounts/answer/6010255?hl=en)
For SMS Notification, the current package version support Twillio service where based on account credentials the user is authenticated in our package. It should be noted, free trial is available
in Twillio. [Twillio Link](https://pages.twilio.com/twilio-brand-sales-namer-1?utm_source=bing&utm_medium=cpc&utm_term=twilio&utm_campaign=B_S_NAMER_Brand_Twilio&cq_src=bing_ads&cq_cmp=B_S_NAMER_Brand_Twilio&cq_con=Twilio%20-%20Phrase&cq_term=twilio&cq_med=&cq_net=o&cq_plt=bp&msclkid=ff15212c0a65142c696945e67a200330&utm_content=Twilio%20-%20Phrase)
To utilize SMS service please follow below steps:
```python
from NotifPy import SMSNotif
sender = SMSNotif.SMS_notif(body = "it's me Hi", recipient_phone_number= '+1...')
sender.twillio(account_sid="your account_sid from Twillio", auth_token="your auth_token from Twillio", twilio_phone_number="your number from Twillio")
```
## How to create this package
To create this package, you need to establish a directory of your choice (e.g., NotifPy) where you should place the __init__.py file and your Python files. It is worth noting that creating a directory like NotifPy.egg_info is unnecessary as it will be generated automatically. The package configuration can be facilitated with the setup.cfg file. You may adjust the version available on this repository to suit your package requirements.
In addition, the pyproject.toml file serves to specify the build backend and the essential build tools for the Python project. For the README.md file, it is important to recognize that this version may differ from the one displayed on pypi.org; therefore, it should be modified accordingly. Lastly, the license holds significance in clarifying the legal aspects of the app. If your package is intended for public accessibility, you can utilize the LICENSE of this package (with minor modifications such as changing the name and date). Alternatively, for more specific cases, you can refer to choosealicense.com.
Once all configurations are set, in this directory, execute the following command:
```
py -m build
```
Subsequently, a folder named "dist" will be generated. Ensure that you have active accounts on both [test.pypi.org](https://test.pypi.org/) and [pypi.org](https://pypi.org/).
It is advisable to begin by testing your package on [test.pypi.org](https://test.pypi.org/) to assure its performance before proceeding to upload it on [pypi.org](https://pypi.org/). The following steps should be followed for the upload process:
```
python -m twine upload --repository testpypi dist/*
```
```
python -m twine upload --repository pypi dist/*
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ArianFotouhi",
"name": "NotifPy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Arian",
"author_email": "arianspiderman@yahoo.com",
"download_url": "https://files.pythonhosted.org/packages/29/81/6c9027c4a0703b0752afed0e7f0d29735aafcc8a9ad3e60a04815ee07e4e/NotifPy-0.0.4.tar.gz",
"platform": null,
"description": "# NotifPy \nAvailable on https://pypi.org/project/NotifPy/\n\nNotifPy is an all-in-one Python package designed to enable users to effortlessly send email and SMS notifications or alerts to designated email addresses and phone numbers. With NotifPy, integrating robust email and SMS functionalities into applications becomes seamless, facilitating prompt communication with target audiences.\n\nStart Using NotifPy by \n\n```bash\npip install NotifPy\n```\n\nTo employ email services follow the below steps:\n\n```python\nfrom NotifPy import EmailNotif\nsender = EmailNotif.email_notif(sender_address='A@B.com', sender_password='your_email_password', recipient_email='B@C.com')\nsender.EmailSender(subject = \"It's me! Hi!\", body='This is a test')\n```\n\nIt is noteworthy, the default email service provider of package is gmail while simply it can be configured to yahoo, outlook/hotmail and the customized mode:\n```python\nsender.EmailSender(subject = \"It's me! Hi!\", body='This is a test', email_provider='yahoo')\nsender.EmailSender(subject = \"It's me! Hi!\", body='This is a test', email_provider='outlook')\n```\n\nFor customized mode, it can be set based on SMTP server and port of your choice. For instance, for AOL mail:\n```python\nsender.EmailSender(subject = \"It's me! Hi!\", body='This is a test', email_provider='', custom_server='smtp.aol.com', custom_port=587)\n```\n\nFurthermore, to use gmail service, due to recent Google policy, you need to first activate 2-step verfication then generate a 16-character app password for your email and use that password here. [Google App Password](https://support.google.com/accounts/answer/6010255?hl=en)\n\nFor SMS Notification, the current package version support Twillio service where based on account credentials the user is authenticated in our package. It should be noted, free trial is available\nin Twillio. [Twillio Link](https://pages.twilio.com/twilio-brand-sales-namer-1?utm_source=bing&utm_medium=cpc&utm_term=twilio&utm_campaign=B_S_NAMER_Brand_Twilio&cq_src=bing_ads&cq_cmp=B_S_NAMER_Brand_Twilio&cq_con=Twilio%20-%20Phrase&cq_term=twilio&cq_med=&cq_net=o&cq_plt=bp&msclkid=ff15212c0a65142c696945e67a200330&utm_content=Twilio%20-%20Phrase)\n\nTo utilize SMS service please follow below steps:\n\n```python\nfrom NotifPy import SMSNotif\nsender = SMSNotif.SMS_notif(body = \"it's me Hi\", recipient_phone_number= '+1...')\nsender.twillio(account_sid=\"your account_sid from Twillio\", auth_token=\"your auth_token from Twillio\", twilio_phone_number=\"your number from Twillio\")\n```\n\n\n\n\n\n## How to create this package\n\nTo create this package, you need to establish a directory of your choice (e.g., NotifPy) where you should place the __init__.py file and your Python files. It is worth noting that creating a directory like NotifPy.egg_info is unnecessary as it will be generated automatically. The package configuration can be facilitated with the setup.cfg file. You may adjust the version available on this repository to suit your package requirements.\n\nIn addition, the pyproject.toml file serves to specify the build backend and the essential build tools for the Python project. For the README.md file, it is important to recognize that this version may differ from the one displayed on pypi.org; therefore, it should be modified accordingly. Lastly, the license holds significance in clarifying the legal aspects of the app. If your package is intended for public accessibility, you can utilize the LICENSE of this package (with minor modifications such as changing the name and date). Alternatively, for more specific cases, you can refer to choosealicense.com.\n\nOnce all configurations are set, in this directory, execute the following command:\n\n```\npy -m build\n```\nSubsequently, a folder named \"dist\" will be generated. Ensure that you have active accounts on both [test.pypi.org](https://test.pypi.org/) and [pypi.org](https://pypi.org/).\n\nIt is advisable to begin by testing your package on [test.pypi.org](https://test.pypi.org/) to assure its performance before proceeding to upload it on [pypi.org](https://pypi.org/). The following steps should be followed for the upload process:\n\n```\npython -m twine upload --repository testpypi dist/*\n```\n\n```\npython -m twine upload --repository pypi dist/*\n```\n\n",
"bugtrack_url": null,
"license": "",
"summary": "NotifPy is here to send alert, notification and promotion related email and SMS",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://github.com/ArianFotouhi"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1ba64b52a091e56ff75d801d0e9e646f04e3ca8281999678ac46b3c746a50b19",
"md5": "8801175ae16500aa2a8d51174d6c6378",
"sha256": "3b472f457af1055b674a7e0c082dbe688ce08854f19ef5f9d4d726a6584f7dc5"
},
"downloads": -1,
"filename": "NotifPy-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8801175ae16500aa2a8d51174d6c6378",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 5517,
"upload_time": "2023-08-03T21:07:47",
"upload_time_iso_8601": "2023-08-03T21:07:47.033951Z",
"url": "https://files.pythonhosted.org/packages/1b/a6/4b52a091e56ff75d801d0e9e646f04e3ca8281999678ac46b3c746a50b19/NotifPy-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "29816c9027c4a0703b0752afed0e7f0d29735aafcc8a9ad3e60a04815ee07e4e",
"md5": "5a5f07106870d73c37f6f02ec98d0e20",
"sha256": "12b05d121cd6e7824dbfc8590de86434b9ebcae67cbbeceb7aba3bb2cfa5a4aa"
},
"downloads": -1,
"filename": "NotifPy-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "5a5f07106870d73c37f6f02ec98d0e20",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4826,
"upload_time": "2023-08-03T21:07:48",
"upload_time_iso_8601": "2023-08-03T21:07:48.335217Z",
"url": "https://files.pythonhosted.org/packages/29/81/6c9027c4a0703b0752afed0e7f0d29735aafcc8a9ad3e60a04815ee07e4e/NotifPy-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-03 21:07:48",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "notifpy"
}
