Skip to main content

Mocean Client Library for Python

Project description

MoceanAPI Client Library for Python

Latest Stable Version Github Build Status codecov codacy license

This is the Python client library for use Mocean's API. To use this, you'll need a Mocean account. Sign up for free at moceanapi.com.

Installation

To use the client library you'll need to have created a Mocean account.

Install from PyPi using pip, a package manager for Python.

pip install moceansdk

Usage

Create a client with your API key and secret:

from moceansdk import Client, Basic

credential = Basic("API_KEY_HERE", "API_SECRET_HERE")
mocean = Client(credential)

Example

To use Mocean's SMS API to send an SMS message, call the mocean.sms.send() method.

The API can be called directly, using a simple array of parameters, the keys match the parameters of the API.

res = mocean.sms.send({
    "mocean-from": "MOCEAN",
    "mocean-to": 60123456789,
    "mocean-text": "Hello World"
})

print(res)

Responses

For your convenient, the API response has been parsed to dict using dotmap package.

print(res)           # show full response string
print(res.status)    # show response status, '0' in this case
print(res['status']) # same as above

Documentation

Kindly visit MoceanApi Docs for more usage

License

This library is released under the MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

moceansdk-1.1.4.tar.gz (12.8 kB view hashes)

Uploaded Source

Built Distribution

moceansdk-1.1.4-py3-none-any.whl (24.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page