An open API service indexing awesome lists of open source software.

https://github.com/wtsi-hgi/python-rt

Clone of git://git.nic.cz/python-rt.git
https://github.com/wtsi-hgi/python-rt

Last synced: about 2 months ago
JSON representation

Clone of git://git.nic.cz/python-rt.git

Awesome Lists containing this project

README

        

==============================================
Rt - Python interface to Request Tracker API
==============================================

Python implementation of REST API described here:
http://requesttracker.wikia.com/wiki/REST

REQUIREMENTS
============

This module uses following Python modules:

- requests (http://docs.python-requests.org/)
- nose (http://nose.readthedocs.org)
- six (http://pythonhosted.org/six/)

Requirements can be installed running::

pip install -r requirements.txt

LICENCE
=======

This module is distributed under the terms of GNU General Public Licence v3
and was developed by CZ.NIC Labs - research and development department of
CZ.NIC association - top level domain registy for .CZ. Copy of the GNU
General Public License is distributed along with this module.

USAGE
=====

An example is worth a thousand words::

>>> import rt
>>> tracker = rt.Rt('http://localhost/rt/REST/1.0/', 'user_login', 'user_pass')
>>> tracker.login()
True
>>> map(lambda x: x['id'], tracker.search(Queue='helpdesk', Status='open'))
['ticket/1', 'ticket/2', 'ticket/10', 'ticket/15']
>>> tracker.create_ticket(Queue='helpdesk', \
... Subject='Coffee (important)', Text='Help I Ran Out of Coffee!')
19
>>> tracker.edit_ticket(19, Requestors='[email protected]')
True
>>> tracker.reply(19, text='Do you know Starbucks?')
True
>>> tracker.logout()
True

Please use docstrings to see how to use different functions. They are written
in ReStructuredText. You can also generate HTML documentation by running
``make html`` in doc directory (Sphinx required).

OFFICIAL SITE
=============

Project site and issue tracking:
https://gitlab.labs.nic.cz/labs/python-rt

Git repository:
git://git.nic.cz/python-rt.git