notify-sms-py


Namenotify-sms-py JSON
Version 1.1.2 PyPI version JSON
download
home_page
SummaryNotify is a bulk SMS Module for sending SMS's accross local zambian phone numbers. It is embedded in [GameBox - Download the app here.]( https://play.google.com/store/apps/details?id=com.microtech.gamebox)
upload_time2024-03-17 14:43:45
maintainer
docs_urlNone
author
requires_python>=3.12
license
keywords bulk sms sms zambia
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ## Notify Bulk SMS Library Documentation

## Introduction

https://www.olympusmedia.co.zm

Notify is a bulk SMS Module for sending SMS's accross local zambian phone numbers. It is embedded in [GameBox - Download the app here.](https://play.google.com/store/apps/details?id=com.microtech.gamebox)

## Instructions

Download GameBox and Sign Up. [GameBox - Download the app here.](https://play.google.com/store/apps/details?id=com.microtech.gamebox)
Place your username and password in .env file as

```python
NOTIFY_SMS_USERNAME="2609xxxxxxx"
NOTIFY_SMS_PASSWORD="***********"
```

## ⚙️ Installation

Before you begin, ensure you have Python installed on your system. This module requires Python version 3.12 or **higher** to run.

```python
pip install notify_sms_py
```

## ⚡️ Quickstart

### Get Sender

Returns all the senders(business name) you created on your profile

```python
from notify_sms_py import notify_sms

client = notify_sms.NewClient(
    username="26097xxxxxx",
    password="*********"
)
res = client.get_senders()

print(res)


```

### Send SMS to Contact(s)

Sends sms to a list of recipients defined as contacts

```python
from notify_sms_py import notify_sms

client = notify_sms.NewClient(
    username="26097xxxxxx",
    password="*********"
)

res = client.send_to_contacts(contacts=["+26097xxxxxx"], message="Hello Patrick from Notify SMS", sender_id="1234888888888888888888")

print(res)

```

## 🎯 Features

- Send SMS to channel
- Send SMS to contact groups
- Send SMS to contacts
- Check SMS balance(WIP) - Coming soon

## 👍 Contribute

If you want to say Thank You and/or support the active development of Notify SMS:

- Add a GitHub Star to the project.
- Tweet about the project on your 𝕏 (Twitter).
- Write a review or tutorial on [Medium](https://www,medium.com), [Dev.to](https://www.dev.to) or personal blog.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "notify-sms-py",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": "",
    "keywords": "bulk sms,sms,zambia",
    "author": "",
    "author_email": "Patrick Kabwe <patrickckabwe@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/c5/15/7cfe9221fb5f50eb7bd315f18264ea3fb7889f407473b505af87634f488f/notify_sms_py-1.1.2.tar.gz",
    "platform": null,
    "description": "## Notify Bulk SMS Library Documentation\n\n## Introduction\n\nhttps://www.olympusmedia.co.zm\n\nNotify is a bulk SMS Module for sending SMS's accross local zambian phone numbers. It is embedded in [GameBox - Download the app here.](https://play.google.com/store/apps/details?id=com.microtech.gamebox)\n\n## Instructions\n\nDownload GameBox and Sign Up. [GameBox - Download the app here.](https://play.google.com/store/apps/details?id=com.microtech.gamebox)\nPlace your username and password in .env file as\n\n```python\nNOTIFY_SMS_USERNAME=\"2609xxxxxxx\"\nNOTIFY_SMS_PASSWORD=\"***********\"\n```\n\n## \u2699\ufe0f Installation\n\nBefore you begin, ensure you have Python installed on your system. This module requires Python version 3.12 or **higher** to run.\n\n```python\npip install notify_sms_py\n```\n\n## \u26a1\ufe0f Quickstart\n\n### Get Sender\n\nReturns all the senders(business name) you created on your profile\n\n```python\nfrom notify_sms_py import notify_sms\n\nclient = notify_sms.NewClient(\n    username=\"26097xxxxxx\",\n    password=\"*********\"\n)\nres = client.get_senders()\n\nprint(res)\n\n\n```\n\n### Send SMS to Contact(s)\n\nSends sms to a list of recipients defined as contacts\n\n```python\nfrom notify_sms_py import notify_sms\n\nclient = notify_sms.NewClient(\n    username=\"26097xxxxxx\",\n    password=\"*********\"\n)\n\nres = client.send_to_contacts(contacts=[\"+26097xxxxxx\"], message=\"Hello Patrick from Notify SMS\", sender_id=\"1234888888888888888888\")\n\nprint(res)\n\n```\n\n## \ud83c\udfaf Features\n\n- Send SMS to channel\n- Send SMS to contact groups\n- Send SMS to contacts\n- Check SMS balance(WIP) - Coming soon\n\n## \ud83d\udc4d Contribute\n\nIf you want to say Thank You and/or support the active development of Notify SMS:\n\n- Add a GitHub Star to the project.\n- Tweet about the project on your \ud835\udd4f (Twitter).\n- Write a review or tutorial on [Medium](https://www,medium.com), [Dev.to](https://www.dev.to) or personal blog.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Notify is a bulk SMS Module for sending SMS's accross local zambian phone numbers. It is embedded in [GameBox - Download the app here.]( https://play.google.com/store/apps/details?id=com.microtech.gamebox)",
    "version": "1.1.2",
    "project_urls": {
        "homepage": "https://github.com/patrickkabwe/notify_sms",
        "issues": "https://github.com/patrickkabwe/notify_sms/issues"
    },
    "split_keywords": [
        "bulk sms",
        "sms",
        "zambia"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a00d8693adce938b2143117089f701d48942040c03af37eb985d0ea711ad15cc",
                "md5": "258bf3d491aa108de407f7ec2136a616",
                "sha256": "26390348c29bbc64b8eff3db09fc17a30091fffc2bef3c1eeb7da8ebd2faf234"
            },
            "downloads": -1,
            "filename": "notify_sms_py-1.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "258bf3d491aa108de407f7ec2136a616",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 4893,
            "upload_time": "2024-03-17T14:43:42",
            "upload_time_iso_8601": "2024-03-17T14:43:42.477619Z",
            "url": "https://files.pythonhosted.org/packages/a0/0d/8693adce938b2143117089f701d48942040c03af37eb985d0ea711ad15cc/notify_sms_py-1.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c5157cfe9221fb5f50eb7bd315f18264ea3fb7889f407473b505af87634f488f",
                "md5": "a7b730df159c8c9494ff84746f028c86",
                "sha256": "05e97dc14d97d2e275c4f91f4ecad93bf450cc959bf8259cef548007bf37236c"
            },
            "downloads": -1,
            "filename": "notify_sms_py-1.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "a7b730df159c8c9494ff84746f028c86",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 14189,
            "upload_time": "2024-03-17T14:43:45",
            "upload_time_iso_8601": "2024-03-17T14:43:45.767869Z",
            "url": "https://files.pythonhosted.org/packages/c5/15/7cfe9221fb5f50eb7bd315f18264ea3fb7889f407473b505af87634f488f/notify_sms_py-1.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-17 14:43:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "patrickkabwe",
    "github_project": "notify_sms",
    "github_not_found": true,
    "lcname": "notify-sms-py"
}
        
Elapsed time: 0.20280s