python-xmatters 1.1.1

Python xMatters API wrapper

python-xmatters

python-xmatters is a wrapper for the xMatters API.

Features

• Most documented endpoints and objects implemented.
• Auto-refresh of access tokens and storage of tokens.
• Support for both basic and OAuth2 authentication.
• Support for most query parameters.
• Support for pagination objects.
• Conversion to datetime objects (local or UTC timezone) for time attributes.

Requirements

• Python 3.5+

Installation

$ pip install python-xmatters

Documentation

See python-xmatters.readthedocs.io and xMatters REST API Reference for object reference.

Example Usage

Authentication

Basic Authentication

from xmatters import XMSession

xm = XMSession('my_instance.xmatters.com')
xm.set_authentication(username='my_username', password='my_password')
groups = xm.groups_endpoint()
for group in groups.get_groups():
    print(group.target_name)

OAuth2 Authentication

It is assumed that if a client_id is provided; OAuth2 authentication is desired.

Using refresh token

from xmatters import XMSession

refresh_token = 'my-refresh-token'
xm = XMSession('my_instance.xmatters.com')
xm.set_authentication(client_id='my-client-id', token=refresh_token)
groups = xm.groups_endpoint()
for group in groups.get_groups():
    print(group.target_name)

Using token object

from xmatters import XMSession

my_token = {
    "access_token": "my-access-token",
    "token_type": "bearer",
    "refresh_token": "my-refresh-token",
    "expires_in": 900,
    "jti": "my-jti",
    "sbu": "my-sbu",
    "expires_at": 0123456789.012345
}
xm = XMSession('my_instance.xmatters.com')
xm.set_authentication(client_id='my-client-id', token=my_token)
groups = xm.groups_endpoint()
for group in groups.get_groups():
    print(group.target_name)

Using username and password with token storage

Any class instance with read_token and write_token methods should work as token_storage

from xmatters import XMSession
from xmatters.utils import TokenFileStorage

token_storage = TokenFileStorage('/path/to/my_token.json')
xm = XMSession('my_instance.xmatters.com')
xm.set_authentication(client_id='my-client-id', username='my_username', password='my_password',
                      token_storage=token_storage)
groups = xm.groups_endpoint()
for group in groups.get_groups():
    print(group.target_name)

Timestamp conversion to local timezone

from xmatters import XMSession
from xmatters.utils import TokenFileStorage

token_storage = TokenFileStorage('/path/to/my_token.json')
xm = XMSession('my_instance.xmatters.com')
xm.set_authentication(client_id='my-client-id', token_storage=token_storage)
groups = xm.groups_endpoint()
for group in groups.get_groups():
    print(group.created.local())