A Python wrapper for [https://arkesel.com] - an unofficial implementation.

• Installation
• Usage
• Examples
• Contributing
• License

you can install the package using Pip

pip install arkesel

from arkesel.smsv1 import SMSV1

sms = SMSV1(api_key="ARKESEL-API-KEY")

look in documentation for full examples

from arkesel.smsV2 import SMSV2

sms = SMSV2(api_key="ARKESEL-API-KEY")

response = sms.send_sms(sender="Trial",message="Trial Message",recipient=["02xxxxxxy1","0232xxxxxx","050xxxxxxx"])

{
  "status": "success",
  "data": [
    {
      "recipient": "02xxxxxxy1",
      "id": "9b752841-7ee7-4d40-b4fe-768bfb1da4f0"
    },
    {
      "recipient": "0232xxxxxx",
      "id": "7ea01acd-485c-4df3-b646-e9e24430e145"
    },
    {
      "invalid numbers": [
        "050xxxxxxx"
      ]
    }
  ]
}

from arkesel.otp import OTP

otp = OTP(api_key="ARKESEL-API-KEY")

response = otp.sms_otp(expiry_minutes=6,recipient="027xxxxxxx",sender_id="Trial")

{
  "code": "1000",
  "ussd_code": "*928*01#",
  "message": "Successful, OTP is being processed for delivery"
}

Check full docs for more help[]

We welcome contributions to improve the project! This guide will help you get started with contributing to our project.

1. Fork the repository.

2. Clone the forked repository to your local machine:

   git clone https://github.com/aglili/arkesel-py.git

3. Create a new branch for your feature or bugfix

   git checkout -b feature/your-feature   # For a new feature
   git checkout -b bugfix/your-bug-fix    # For a bug fix

4. Make your changes and commit them

   git add .
   git commit -m "Description of your changes"

5. Push your branch to GitHub

   git push origin your-branch-name

6. Open a pull request (PR) to the main repository's main branch. Provide a clear and descriptive title for your PR.

This project is licensed under the MIT License. See the LICENSE file for details.