Python interface to Request Tracker API
Project description
Rt - Python interface to Request Tracker API
- Python implementation of REST API described here:
Python |
rt |
|---|---|
2.7 |
< 2.0.0 |
>= 3.5, <3.7 |
>= 2.0.0, < 3.0.0 |
>= 3.7 |
>= 3.0.0, < 3.1.0 |
>= 3.8 |
>= 3.0.0 |
- ℹ️ Note:
Please note that starting with the major release of v3.0.0, this library requires Python version >= 3.8. See the Python version compatibility table above for more detailed information.
- ⚡ Note:
As of version 3.1.0, this library is async compatible. Usage:
import rt.rest2 import httpx tracker = rt.rest2.AsyncRt('http://localhost/rt/REST/2.0/', http_auth=httpx.BasicAuth('root', 'password'))- ⚠️ Warning:
Though version 3.x still supports RT REST API version 1, it contains minor breaking changes. Please see the changelog in the documentation for details.
Requirements
- This module uses following Python modules:
requests (http://docs.python-requests.org/)
requests-toolbelt (https://pypi-hypernode.com/project/requests-toolbelt/)
typing-extensions (depending on python version)
Documentation
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 registry 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.rest2
>>> import httpx
>>> tracker = rt.rest2.Rt('http://localhost/rt/REST/2.0/', http_auth=httpx.BasicAuth('root', 'password'))
>>> map(lambda x: x['id'], tracker.search(Queue='helpdesk', Status='open'))
['1', '2', '10', '15']
>>> tracker.create_ticket(queue='helpdesk', \
... subject='Coffee (important)', content='Help I Ran Out of Coffee!')
19
>>> tracker.edit_ticket(19, Requestor='addicted@example.com')
True
>>> tracker.reply(19, content='Do you know Starbucks?')
True
Get the last important updates from a specific queue that have been updated recently:
>>> import datetime
>>> import base64
>>> import rt.rest2
>>> import httpx
>>> tracker = rt.rest2.Rt('http://localhost/rt/REST/2.0/', http_auth=httpx.BasicAuth('root', 'password'))
>>> 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']
>>> history = tracker.get_ticket_history(id)
>>> last_update = list(reversed([h for h in history if h['Type'] in ('Correspond', 'Comment')]))
>>> hid = tracker.get_transaction(last_update[0]['id'] if last_update else history[0]['id'])
>>>
>>> attachment_id = None
>>> for k in hid['_hyperlinks']:
>>> if k['ref'] == 'attachment':
>>> attachment_id = k['_url'].rsplit('/', 1)[1]
>>> break
>>>
>>> if attachment_id is not None:
>>> attachment = c.get_attachment(attachment_id)
>>> if attachment['Content'] is not None:
>>> content = base64.b64decode(attachment['Content']).decode()
>>> print(content)
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:
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file rt-3.1.1.tar.gz.
File metadata
- Download URL: rt-3.1.1.tar.gz
- Upload date:
- Size: 79.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f814f5d197942448900fdee2cf60148b412c75ea7547e2f57ddb2df5b03221c0 |
|
| MD5 | c798f1551df7eaf3c7eb153ebb4f2608 |
|
| BLAKE2b-256 | 00c2aa506829d3466f6bbd920abb5dcc1f487d018d6f8a54365952001f6523d0 |
File details
Details for the file rt-3.1.1-py3-none-any.whl.
File metadata
- Download URL: rt-3.1.1-py3-none-any.whl
- Upload date:
- Size: 53.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 224f07796ac16478a2c70445b461181805bb9518d4a890ebcecf579f8c195c84 |
|
| MD5 | 04dc8ef734f4fd00303bc31a4316f869 |
|
| BLAKE2b-256 | 17b9271125a449a8021e69717648f3ceee59436f631f6bee13b152c2cd0ed52e |
