• Request Tracker REST Interface

• rtkit.authenticators
• rtkit.comment
• rtkit.entities
• rtkit.errors
• rst.forms
• rtkit.parser
• rtkit.resource
• rtkit.tracker
• Developers Guide

rtkit - Project Links

• Source Code at github
  github.com/z4r/python-rtkit
• Latest Docs at ReadTheDocs
  python-rtkit.readthedocs.org/
• Travis CI
  travis-ci.org/z4r/python-rtkit

Other Links

• Request Tracker (RT) Home
  bestpractical.com/rt/
• RT REST API
  requesttracker.wikia.com/wiki/REST
  Or shorter Local Summary

rtkit.resource

class rtkit.resource.RTObj(dic=None)

RT Simple Object Container. This is a quick hack to make the data returned slightly oo with some helpers.

Parameters:dic – The dictionary to make Oo

mydata = {'Foo': 'Var'}
myObj = RTObj(mydata)
print myObj.Foo

resource = RTResource('http://rt.example.com/REST/1.0/', 'webmaster', 'secret', CookieAuthenticator)
try:
    response = resource.get(path='ticket/28')
    myTicket = response.as_object() ## Returns an RtObj instance
    
except RTResourceError as e:
    logger.error(e.response.status_int)
    logger.error(e.response.status)
    logger.error(e.response.parsed)

## Show Stuff
print myTicket.Subject, myTicket.id
print myTicket.get_custom("my_custom")
print myTicket.keys()  # list of keys
print mtTicket.as_dict() # return as dict and key/value pair

## Update Stuff
myTicket.set_custom("my_custom", "New Val")
myTicker.Subject = myTicket.Subject + " my Xtra"

as_dict()

Returns:Dictionary of data as key value pairs

get(name)

This is useful as some “keys” are not ooable eg ob.get(“X-yx”);

Parameters:name – The value to get Returns:The value of name.

get_custom(name)

Get a custom field, a short cut to CF.{name}

Parameters:name – of custom field eg ‘Works Order’ Returns:the data as string

keys()

Returns:A list with strings of the field names

set_custom(name, val)

Set a custom field, a short cut to CF.{name}

Parameters:

• name – of custom field eg ‘Works Order’
• val – New value to set to

class rtkit.resource.RTResource(url, username, password, auth, **kwargs)

Bases: object

REST Resource Object

Create Connection Object

Parameters:

• url – Server URL
• username – RT Login
• password – Password
• auth – Instance of rtkit.authenticators

get(path=None, headers=None)

GET from the server

post(path=None, payload=None, headers=None)

POST to the server

request(method, path=None, payload=None, headers=None)

Make request to server

class rtkit.resource.RTResponse(request, response)

Bases: object

Represents the REST response from server

as_dict()

Returns:dict with the data

as_object()

Returns:A rtkit.resource.RTObj object instance

body = None

Request Body

headers = None

Headers as dict

logger = None

Logger

parsed = None

A List of Tuples of data

status = None

Status String

status_int = None

Status Code