Skip to main content

Python interface to Request Tracker API

Project description

codebeat badge tests Documentation Status https://badge.fury.io/py/rt.svg

Rt - Python interface to Request Tracker API

Python implementation of REST API described here: https://rt-wiki.bestpractical.com/wiki/REST

Note: Please note that starting with the major release of v2.0.0, this library requires a Python version >= 3.5. In case you still require a Python 2 version or one compatible with Python < 3.5, please use a version < 2.0.0 of this library.

REQUIREMENTS

This module uses following Python modules:

Unit-tests are implemented using: - nose (http://nose.readthedocs.org)

INSTALLATION

Install the python-rt package using:

pip install rt

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='addicted@example.com')
True
>>> tracker.reply(19, text='Do you know Starbucks?')
True
>>> tracker.logout()
True

Get the last important updates from a specific queue that have been updated recently:

>>> import rt
>>> tracker = rt.Rt('http://localhost/rt/REST/1.0/', http_auth=HTTPBasicAuth(os.environ['rtuser'], os.environ['rtpasswd']))
>>> tracker.default_queue = "my-queue"
>>> fifteen_minutes_ago = str(datetime.datetime.now() - datetime.timedelta(minutes=15))
>>> tickets = tracker.last_updated(since=fifteen_minutes_ago)
>>> for ticket in tickets:
>>>     id = ticket['id'][7:]
>>>     history = tracker.get_short_history(id)
>>>     last_update = list(reversed([h for h in history if h[1].startswith('Correspondence added') or h[1].startswith('Comments added')]))
>>>     hid = tracker.get_history(id, last_update[0][0] if last_update else history[0][0])[0]
>>>     print("http://localhost/rt/Ticket/Display.html?id=%s" % id)
>>>     print(hid['Content'])
>>>     print("\n")

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, issue tracking and git repository:

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

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

rt-2.2.2.tar.gz (50.6 kB view details)

Uploaded Source

Built Distribution

rt-2.2.2-py3-none-any.whl (30.6 kB view details)

Uploaded Python 3

File details

Details for the file rt-2.2.2.tar.gz.

File metadata

  • Download URL: rt-2.2.2.tar.gz
  • Upload date:
  • Size: 50.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for rt-2.2.2.tar.gz
Algorithm Hash digest
SHA256 79e4f7a101e2ed1bd9dc851aafa3f388cb6abaf861e3c10f96382dbaed54949f
MD5 0c8db1d95e810a08a529d2dc1114f029
BLAKE2b-256 477834802be74e4ffed05595ffa839bcb9db4ee277f4ab558fbea91f8ea9e220

See more details on using hashes here.

File details

Details for the file rt-2.2.2-py3-none-any.whl.

File metadata

  • Download URL: rt-2.2.2-py3-none-any.whl
  • Upload date:
  • Size: 30.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for rt-2.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 88f046dac788ca1b4ace2d2b5ddf40838f43251d991f0464071965894b309157
MD5 d3e45206b9701ce24c8dcad6f0f3b158
BLAKE2b-256 ed267fe066e7a388489c6e6c14f8f2559346db955d87c3b7228fccf3de1279da

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