A Python Package for communicating with the Courier REST API.
Project description
trycourier
This Python Package helps you send notifications through Courier, the smartest way to design & deliver notifications. Design your notifications once using our drag & drop editor, then deliver to any channel through one API. Email, mobile push, SMS, Slack — you name it!
Installation
Install from PyPI using pip:
$ pip install trycourier
Python 3.5 or later is required.
Usage
Using Token Auth
from trycourier import Courier
client = Courier(auth_token="your-auth-token") #or set via COURIER_AUTH_TOKEN env var
resp = client.send(
event="your-event-id",
recipient="your-recipient-id",
profile={
"email": "example@example.com",
"phone_number": "555-867-5309"
},
data={
"world": "Python!"
}
)
print(resp['messageId'])
Using Basic Auth
from trycourier import Courier
client = Courier(username="your-username", password="your-password")
resp = client.send(
event="your-event-id",
recipient="your-recipient-id",
profile={
"email": "example@example.com",
"phone_number": "555-867-5309"
},
data={
"world": "Python!"
}
)
print(resp['messageId'])
Advanced Usage
from trycourier import Courier
client = Courier(auth_token="your-auth-token")
"""
Example: send a message
"""
resp = client.send(
event="your-event-id",
recipient="your-recipient-id",
profile={}, # optional
data={}, # optional
preferences={}, # optional
override={} # optional
)
print(resp['messageId'])
"""
Example: replace or create a recipient's profile
"""
resp = client.replace_profile(
recipient_id,
{
"email": "example@example.com"
}
)
print(resp['status'])
"""
Example: merge or create a recipient's profile
"""
resp = client.merge_profile(
recipient_id,
{
"phone_number": "+15555555555"
}
)
print(resp['status'])
"""
Example: get a recipient's profile
"""
resp = client.get_profile(recipient_id)
print(resp)
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/trycourier/courier-python. See CONTRIBUTING.md for more info.
License
The package is available as open source under the terms of the MIT License.
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
trycourier-1.1.0.tar.gz
(6.2 kB
view hashes)
Built Distribution
Close
Hashes for trycourier-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da08ec60d2f35dc2d4de08c0fee962a4c8cb56e2ecce7055a330d4826c76cb4a |
|
MD5 | dc0343b191fc21e825b9130fccd12410 |
|
BLAKE2b-256 | 63ce0afd87a57dfca01b2e9a54f5378b59d1c11e4f8b32abc8e78d9349477fde |