Skip to main content

Python library for interfacing with the TeamSupport API

Project description

Python TeamSupport Client
=========================


|Build Status| |Latest Version|

Python library for interfacing with the TeamSupport XML API, using `demands <https://github.com/yola/demands>`__.

Free software: MIT license

Features
--------

- Client methods parse response content in order to return LXML Element
objects
- Converting Python dictionaries into XML for POST and PUT calls
- Simple models for Tickets and Actions.

Usage
-----

::

from teamsupport import Ticket, init

init(<org_id>, <auth_key>)

# Get ticket with given ID/Number.
ticket = Ticket(<ticket_number_or_ticket_id>)

# Create new ticket.
ticket = Ticket.create(
contact_email, contact_first_name, contact_last_name,
ticket_name, ticket_text)

# Get Ticket description.
descr = ticket.get_description()

# Update ticket description.
ticket.set_decription('New description')

To run integration tests please set correct values in `teamsupport/config.py`
and run: `nosetests integration_tests`

.. |Build Status| image:: https://img.shields.io/travis/yola/teamsupport-python.svg?style=flat-square
:target: https://travis-ci.org/yola/teamsupport-python
.. |Latest Version| image:: https://img.shields.io/pypi/v/teamsupport.svg?style=flat-square
:target: https://warehouse.python.org/project/teamsupport


Running Tests
-------------

Set correct data in teasmsupport/config.py

::

nosetests


Changelog
=========

0.5.0 (2018-07-05)
------------------

- Switched to JSON API.
- Set correct ticket status when creating a ticket


0.4.1 (2018-02-08)
------------------

- Convert input data to str when composing XML.

0.4.0 (2016-10-21)
----------------

- Switched to Demands == 4.0.0

0.3.0 (2015-12-01)
------------------

- Automatically convert DateTime fields to datetime type for Ticket model.

0.2.2 (2015-11-27)
------------------

- Add Ticket.search() and Ticket.update() methods.

0.2.1 (2015-11-27)
------------------

- Fix README.rst formatting.

0.2.0 (2015-11-26)
------------------

- Add `create` class method to the Ticket model; Add `Contact` model;
- Remove User model.
- Change models constructors to not require `client` param.

0.1.3 (2015-09-13)
------------------

- Fix bug in `update_ticket` method

0.1.2 (2015-09-12)
------------------

- Bump version to fix PyPI upload issue

0.1.1 (2015-09-12)
------------------

- Add `User` model and `TeamSupportService.get_user` method.

0.1.0 (2015-09-10)
------------------

- First release on PyPI.

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

teamsupport-0.4.1.tar.gz (8.1 kB view details)

Uploaded Source

File details

Details for the file teamsupport-0.4.1.tar.gz.

File metadata

File hashes

Hashes for teamsupport-0.4.1.tar.gz
Algorithm Hash digest
SHA256 748975021c65f21b63391093dc87a8388be4ff70541d51acdf592764d1fa5d40
MD5 939520388c6f04d2ec38a2915d4b06be
BLAKE2b-256 5f4ffaa26acbbc6a215533b9d2f39078bf3c3e2496086c2949313734fe25d49b

See more details on using hashes here.

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