|
1 | 1 | # nextsms |
2 | 2 | Python Package to easy the integration with nextsms SMS Gateway |
| 3 | + |
| 4 | +Getting started |
| 5 | +--------------- |
| 6 | + |
| 7 | +In order to use this package you need to have the NextSMS Account, If you don't have one please take a look at [NextSMS](https://nextsms.co.tz), and get your *username* and *password* we gonna use them down below; |
| 8 | + |
| 9 | +Install the libary from pip or directly |
| 10 | + |
| 11 | +```bash |
| 12 | +pip install nextsms |
| 13 | +``` |
| 14 | + |
| 15 | +Installing directly from github |
| 16 | + |
| 17 | +Clone this repository or Download a zip of the package and then do this; |
| 18 | + |
| 19 | +``` |
| 20 | +git clone https://github.com/Kalebu/nextsms |
| 21 | +cd nextsms |
| 22 | +nextsms -> python setup.py install |
| 23 | +``` |
| 24 | + |
| 25 | +Here is an example on how to send an SMS with this package; |
| 26 | + |
| 27 | +```python |
| 28 | + |
| 29 | +>> import nextsms |
| 30 | +>> sender = nextsms('your username', 'your password') |
| 31 | +>> sender.sendsms(message='hello', recipients=['075XXXXX',['065XXXX']) |
| 32 | + |
| 33 | +``` |
| 34 | + |
| 35 | +Bulky ? |
| 36 | +------- |
| 37 | +NextSms allows you to predefine all message you would like to send with variety of sender IDs and does the rest on how to successful send to all. |
| 38 | + |
| 39 | +Here an Example how you would do that with this package |
| 40 | + |
| 41 | +```python |
| 42 | + |
| 43 | +>> import nextsms |
| 44 | +>> sender = nextsms('KalebuJordan', 'kalebu@opensource') |
| 45 | +>> messages = [ |
| 46 | + {'from':'NEXTSMS', 'to':'255757294146', 'text':'hello'}, |
| 47 | + {'from':'NEXTSMS', 'to':'255754205561', 'text':'hello'}] |
| 48 | +>> sender.send_bulk(messages) |
| 49 | + |
| 50 | +``` |
| 51 | + |
| 52 | +Environment |
| 53 | +----------- |
| 54 | + |
| 55 | +By default as you can create a nextsms instance it configure the environment to use production urls, If you wanna do on test sandbox here how; |
| 56 | + |
| 57 | +```python |
| 58 | + |
| 59 | +>> import nextsms |
| 60 | +>> sender = nextsms('KalebuJordan', 'kalebu@opensource') |
| 61 | +>> sender.sandbox = True |
| 62 | + |
| 63 | +``` |
| 64 | + |
| 65 | +Wanna Contribute ? |
| 66 | +------------------ |
| 67 | +Just |
| 68 | + - Fork it |
| 69 | + - Create a new branch |
| 70 | + - Do your changes |
| 71 | + - Make a Pull request |
| 72 | + - You're merged congrats .!!! |
| 73 | + |
| 74 | + |
| 75 | +Give it a star |
| 76 | +-------------- |
| 77 | + |
| 78 | +Was this useful to you ? Cool then give it a big star ! |
| 79 | + |
| 80 | + |
| 81 | +Connect with me |
| 82 | +--------------- |
| 83 | + |
| 84 | +I use a lot of twitter , [let's connect on twitter](twitter.com/j_kalebu) . |
| 85 | + |
| 86 | + |
| 87 | +Issues |
| 88 | +------ |
| 89 | + |
| 90 | +Encountered issues while using the package, raise an issue and then we gonna work to fix it as soon as it takes |
| 91 | + |
| 92 | +``` |
| 93 | +More features coming soon |
| 94 | +``` |
| 95 | + |
| 96 | +All the Credits to [kalebu](github.com/kalebu) |
0 commit comments