A Python library for sending SMS messages via BlueSMS
Project description
BlueSMS SDK
This is a python SDK for the BlueSMS API. It can be added to your current python-based application so as to interact with the BlueSMS Uganda API in a much simpler way.
Why we created the BlueSMS SDK
We began using BlueSMS in many of our applications and were simply tired of writing code to send SMSes in every Python project we created. So we decided to create a python package that would make it easier for us to send SMSes in our projects.
Installation
pip install bluesms
Usage
from bluesms.sms import SMS
# initialise the SMS class
sms = SMS()
# send the SMS
try:
sending = sms.send(user="user@example.com", password="password", reciever="0777xxxxxx", sender="sender", message="message")
print("The SMS sent", sending.text)
except Exception as e:
print("Error sending SMS:", e)
Development Setup
Clone the repository by running the following command in your terminal:
git clone https://github.com/mwanjajoel/bluesms.git
We use Pipenv to manage our dependencies. To install pipenv, run the following command:
pip install pipenv
Activate the virtual environment by running the following command in your terminal:
pipenv shell
Install the dependencies by running the following command in your terminal:
pipenv install
Run tests
TBD
Code Formatting using Black
black momo
How to submit an issue
Please follow our Bug Report Guide on how to submit your issue.
How to request for a new feature
Please follow our Feature Request Guide on how to submit a feature request
Code of Conduct
We follow a strict code of conduct and you can read it Here
Credits
BlueSMS SDK was designed and built by Mwanja Joel. It is licensed under the MIT license; for the full license please see the LICENSE file.
Please see the AUTHORS file for the full list of contributors.
If you find BlueSMS SDK useful and want to reach out, find me on Twitter: @mrjoelmwanja.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.