# EBulkSMS Python Library
The EBulkSMS Python library provides a simple interface for sending SMS messages using the eBulkSMS API. It allows you to send SMS messages to multiple recipients, check your account balance, retrieve delivery reports, and more.
## Prerequisites
Before using the EBulkSMS library, make sure you have the following:
- An active account with (EbulkSMS)[https://www.ebulksms.com/signup].
- An API token or login credentials (email and password) associated with your eBulkSMS account.
## Installation
To use the EBulkSMS library, you need to install the requests library. You can install it using pip:
pip install requests
## Getting Started
To begin using the EBulkSMS library, import it into your Python script:
### Initializing the EBulkSMS Object
The EBulkSMS class provides the necessary methods for interacting with the eBulkSMS API. To get started, create an instance of the EBulkSMS class:
```
ebulksms = EBulkSMS(api_token=None, email=None, password=None)
```
You can initialize the EBulkSMS object in two ways:
- Using an API token:
```
ebulksms = EBulkSMS(api_token="your_api_token", email="your_email@example.com")
```
- Using email and password:
```
ebulksms = EBulkSMS(email="your_email@example.com", password="your_password")
```
Note: Provide either an API token or email and password arguments.
### Sending SMS Messages
To send an SMS message, use the sendSMS method:
```
sender = "YourSenderName"
recipients = ["234XXXXXXXXX", "234YYYYYYYYY"]
message = "Your message goes here"
response = ebulksms.sendSMS(sender, recipients, message)
print(response)
```
The sendSMS method takes the following parameters:
`sender`: The name or number that will appear as the sender of the message.
`recipients`: A list of phone numbers (in international format) to which the message will be sent.
`message`: The content of the SMS message.
The method returns a JSON response containing information about the sent message.
### Checking Account Balance
To retrieve your account balance, use the getBalance method:
```
balance = ebulksms.getBalance()
print(balance)
```
The getBalance method returns the account balance as a floating-point number.
### Retrieving Delivery Reports
To get the delivery report for a specific message, use the getDeliveryReport method:
```
unique_id = "your_message_unique_id"
report = ebulksms.getDeliveryReport(unique_id)
print(report)
```
The getDeliveryReport method takes the unique_id of the message as a parameter and returns the delivery report in JSON format.
Note: The `unique_id` is generated automatically when sending the SMS message.
## Error Handling
The EBulkSMS library raises ValueError exceptions when encountering errors. Make sure to handle these exceptions appropriately in your code.
## Contributing
We welcome contributions from the community! If you would like to contribute to the EBulkSMS Python library, please follow these guidelines:
1. Fork the repository and create your branch from the `main` branch.
2. Make your changes and ensure that the code passes all tests.
3. Write clear and concise commit messages.
4. Submit a pull request to the `main` branch.
### Code Style
Please adhere to the following code style guidelines:
- Use PEP 8 style guide for Python code.
- Write clear and meaningful variable and function names.
- Include comments to explain complex logic or important details.
- Follow the existing code formatting and structure.
### Bug Reports and Feature Requests
If you encounter any bugs or have suggestions for new features, please open an issue on the GitHub repository. Provide a clear description of the problem or feature request and any relevant details.
### Contact
If you have any questions or need assistance, you can reach out to us at support@example.com.
We appreciate your contributions and thank you for helping improve the EBulkSMS Python library!
Raw data
{
"_id": null,
"home_page": "https://github.com/emmyvera/ebulksms",
"name": "ebulksms",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "SMS,Nigeria,BulkSMS,EBulkSMS,bulk sms",
"author": "Oluwaloni Emmanuel",
"author_email": "emmyvera01@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5e/e8/e29b35405a94b1ab7d535c79abac1ec7e4bb6042eb4d3c14f466551ccc91/ebulksms-1.0.0.tar.gz",
"platform": null,
"description": "# EBulkSMS Python Library\nThe EBulkSMS Python library provides a simple interface for sending SMS messages using the eBulkSMS API. It allows you to send SMS messages to multiple recipients, check your account balance, retrieve delivery reports, and more.\n\n## Prerequisites\nBefore using the EBulkSMS library, make sure you have the following:\n- An active account with (EbulkSMS)[https://www.ebulksms.com/signup].\n- An API token or login credentials (email and password) associated with your eBulkSMS account.\n\n## Installation\nTo use the EBulkSMS library, you need to install the requests library. You can install it using pip:\n\npip install requests\n\n## Getting Started\nTo begin using the EBulkSMS library, import it into your Python script:\n\n### Initializing the EBulkSMS Object\nThe EBulkSMS class provides the necessary methods for interacting with the eBulkSMS API. To get started, create an instance of the EBulkSMS class:\n\n```\nebulksms = EBulkSMS(api_token=None, email=None, password=None)\n```\n\nYou can initialize the EBulkSMS object in two ways:\n- Using an API token:\n```\nebulksms = EBulkSMS(api_token=\"your_api_token\", email=\"your_email@example.com\")\n```\n\n- Using email and password:\n```\nebulksms = EBulkSMS(email=\"your_email@example.com\", password=\"your_password\")\n```\nNote: Provide either an API token or email and password arguments.\n\n### Sending SMS Messages\nTo send an SMS message, use the sendSMS method:\n\n```\nsender = \"YourSenderName\"\nrecipients = [\"234XXXXXXXXX\", \"234YYYYYYYYY\"]\nmessage = \"Your message goes here\"\n\nresponse = ebulksms.sendSMS(sender, recipients, message)\nprint(response)\n```\nThe sendSMS method takes the following parameters:\n\n`sender`: The name or number that will appear as the sender of the message.\n`recipients`: A list of phone numbers (in international format) to which the message will be sent.\n`message`: The content of the SMS message.\n\nThe method returns a JSON response containing information about the sent message.\n\n### Checking Account Balance\nTo retrieve your account balance, use the getBalance method:\n\n```\nbalance = ebulksms.getBalance()\nprint(balance)\n```\n\nThe getBalance method returns the account balance as a floating-point number.\n\n### Retrieving Delivery Reports\nTo get the delivery report for a specific message, use the getDeliveryReport method:\n\n```\nunique_id = \"your_message_unique_id\"\nreport = ebulksms.getDeliveryReport(unique_id)\nprint(report)\n```\n\nThe getDeliveryReport method takes the unique_id of the message as a parameter and returns the delivery report in JSON format.\n\nNote: The `unique_id` is generated automatically when sending the SMS message.\n\n## Error Handling\nThe EBulkSMS library raises ValueError exceptions when encountering errors. Make sure to handle these exceptions appropriately in your code.\n\n## Contributing\nWe welcome contributions from the community! If you would like to contribute to the EBulkSMS Python library, please follow these guidelines:\n\n1. Fork the repository and create your branch from the `main` branch.\n2. Make your changes and ensure that the code passes all tests.\n3. Write clear and concise commit messages.\n4. Submit a pull request to the `main` branch.\n\n### Code Style\nPlease adhere to the following code style guidelines:\n- Use PEP 8 style guide for Python code.\n- Write clear and meaningful variable and function names.\n- Include comments to explain complex logic or important details.\n- Follow the existing code formatting and structure.\n\n### Bug Reports and Feature Requests\nIf you encounter any bugs or have suggestions for new features, please open an issue on the GitHub repository. Provide a clear description of the problem or feature request and any relevant details.\n\n### Contact\nIf you have any questions or need assistance, you can reach out to us at support@example.com.\n\nWe appreciate your contributions and thank you for helping improve the EBulkSMS Python library!\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The EBulkSMS Python library provides a simple interface for sending SMS messages",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/emmyvera/ebulksms"
},
"split_keywords": [
"sms",
"nigeria",
"bulksms",
"ebulksms",
"bulk sms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5ee8e29b35405a94b1ab7d535c79abac1ec7e4bb6042eb4d3c14f466551ccc91",
"md5": "f021b2a9316a56fd04990b2708bbf3cd",
"sha256": "e8aaa5ea9b8a960b55689891f7d17dec6e75a3b21c4f456d912a56d3c4b8ec6b"
},
"downloads": -1,
"filename": "ebulksms-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "f021b2a9316a56fd04990b2708bbf3cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5161,
"upload_time": "2023-06-16T17:46:08",
"upload_time_iso_8601": "2023-06-16T17:46:08.086149Z",
"url": "https://files.pythonhosted.org/packages/5e/e8/e29b35405a94b1ab7d535c79abac1ec7e4bb6042eb4d3c14f466551ccc91/ebulksms-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-16 17:46:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "emmyvera",
"github_project": "ebulksms",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ebulksms"
}
JSON
