Installation

deskapi is installable from PyPI with easy_install or pip.

$ pip install deskapi

This will download the latest release, along with requests, which it depends on.

Getting Started

Access to the Desk API is managed through a DeskSession object. To instantiate a session, you’ll need a sitename and authentication information. If your Desk.com site is http://example.desk.com, your site name will be example. Authentication information is any valid Requests auth object. The simplest thing to provide is a username and password. For example:

>>> from deskapi.models import DeskSession

>>> session = DeskSession(
...     sitename='example',
...     auth=('nathan@example.com', '53kr17')
... )

Once you have a session ID, you can retrieve a list of Articles:

>>> articles = session.articles()

Article fields map to Python properties:

>>> article = articles[0]
>>> article.subject
'Help Topic'
>>> article.in_support_center
True

Collections and Objects

deskapi models the information available from Desk API as a set of “collections” and “objects”. The articles() method on DeskSesssion returns a collection. Collections can be iterated over, and support indexed access. A collection can create new members in itself.

Each member of a collection is a Desk Object. Desk Objects support property access to their fields, as well as updating those fields.

>>> new_article = articles.create(
...     title='New Article',
...     body='Some content.',
... )

>>> articles = session.articles()

>>> translations = article.translations
>>> len(translations)
2
>>> translations['es'].subject
'Tema de Ayuda'

>>> article.body = 'Test Content'
>>> article.save()

>>> article = article.update(body='Test Content')

License

Made available under a BSD license; see LICENSE for details.

News