A beginner friendly SDK for Termii.
Project description
Termii-py
Super easy SDK for Termii SMS APIs.
Installation
Install using pip install -U termii-py
.
Simple Examples
from termii.token import Token
from termii.schemas.token import TokenType
token_client = Token()
token_client.authenticate_from_env()
response = token_client.send_token(
message_type=TokenType.ALPHANUMERIC,
receiver="2348152436475",
)
print(response)
from termii.messaging import Messaging
messaging_client = Messaging()
messaging_client.authenticate_from_env()
receivers = ["2348152436475", "2347153436435"]
response = messaging_client.send_message(
receivers=receivers,
text="Hello all. Thanks for visiting."
)
print(response)
from termii.campaign import Campaign
campaign_client = Campaign()
campaign_client.authenticate_from_env()
response = campaign_client.create_phonebook(
name="Test", description="Test description."
)
print(response)
Authentication.
There are two ways of authenticating requests:
- With env variables:
To authenticate with environment variables set
TERMII_API_KEY
,TERMII_ENDPOINT_URL
,TERMII_SENDER_ID
to your termii api key, endpoint url and sender ID respectively. Then call client.authenticate_from_env()
Example:
import os
from termii.campaign import Campaign
os.environ["TERMII_API_KEY"] = "ukwiwe4642eh"
os.environ["TERMII_ENDPOINT_URL"] = "https://api.ng.termii.com"
os.environ["TERMII_SENDER_ID"] = "Test"
campaign_client = Campaign()
campaign_client.authenticate_from_env()
- A second method is to pass in the credentials directly. For that call
authenticate_direct()
on all clients and pass-in the credentials.
Contributing
For guidance on setting up a development environment and how to make a contribution to termii-py, see Contributing to Termii-py.
Reporting a Security Vulnerability
Security vulnerabilities are a serious concern. If you discover a potential security issue, please do not create a public issue report. Instead, use the confidential reporting feature provided by GitHub, ensuring the details remain private until a fix is released. You can find instructions on privately reporting vulnerabilities here: Privately reporting a security vulnerability
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for termii_py-0.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5c607f03ceb364388cd9cccd4c3432b807a93d41b9aaa28a97f7c41feaedd2e |
|
MD5 | 12a8a01bd46553e7f35c9baa039cd101 |
|
BLAKE2b-256 | 04046be5dd8d39a03ff8a4e2a728673227f171c4fe71c5cea08fbc9f82507bdd |