ticketutil 1.8.4
Python ticketing utility supporting JIRA, RT, Redmine, Bugzilla, and ServiceNow
Keywords: jira, bugzilla, rt, redmine, servicenow, ticket, rest

ticketutil
==========

.. image:: https://img.shields.io/badge/python-2.7%2C%203.3%2C%203.4%2C%203.5%2C%203.6-blue.svg
    :target: https://pypi.python.org/pypi/ticketutil/1.8.4

.. image:: https://img.shields.io/badge/pypi-v1.8.4-blue.svg
    :target: https://pypi.python.org/pypi/ticketutil/1.8.4

ticketutil is a Python module that allows you to easily interact with
various ticketing tools using their REST APIs. Currently, the supported
tools are JIRA, RT, Redmine, Bugzilla, and ServiceNow. All tools support
HTTP Basic authentication, while JIRA and RT also support Kerberos
authentication. Additionally, Bugzilla supports API key authentication and
Jira supports Personal Access Token authentication.

This module allows you to create tickets, add comments, edit ticket
fields, and change the status of tickets in each tool. Additional
lower-level tool-specific functions are supported - adding and removing
watchers in JIRA, adding attachments in JIRA, etc.

Simplify all of your ticketing operations with ticketutil:

.. code-block:: python

    from ticketutil.jira import JiraTicket
    ticket = JiraTicket(<jira_url>, <project_key>, auth='kerberos')

    # Create a ticket and perform some common ticketing operations.
    t = ticket.create(summary='Ticket summary',
                      description='Ticket description',
                      type='Task')
    t = ticket.add_comment('Test Comment')
    t = ticket.change_status('Done')

    # Check status of previous ticketing operation and print URL of ticket.
    print(t.status)
    print(t.url)

    # Close Requests session.
    ticket.close_requests_session()

Installation
------------

Install ticketutil with ``pip install ticketutil``.

ticketutil is compatible with Python 2.7, 3.3, 3.4, 3.5, and 3.6.
Note: For Python 2.6 and lower, an additional package, importlib, may
need to be installed.

If not installing with pip, a short list of packages defined in the
requirements.txt file need to be installed. To install the required
packages, type ``pip install -r requirements.txt``.

To run the unit tests, type ``python -m unittest discover -s tests``.

Documentation
-------------

Documentation for ticketutil is available at:
http://ticketutil.readthedocs.io.

Comments? / Questions? / Coming Soon
------------------------------------

For questions / comments, email dranck@redhat.com.
For anything specific to Bugzilla, email kshirsal@redhat.com.
For ServiceNow related questions, email pzubaty@redhat.com.

The plan for ticketutil is to support more ticketing tools in the near
future and to support more ticketing operations for the currently
supported tools. Please let us know if there are any suggestions /
requests.
Thanks!

Release History
---------------

1.8.4 (08-08-2025)
++++++++++++++++++

* Fixed unit test mock objects and string matching issues.
* Enhanced test reliability with proper mock object attributes.
* Improved test coverage to 100% success rate (207/207 tests passing).

1.8.3 (06-02-2025)
++++++++++++++++++

* Updated request retries with support for other HTTP request methods.

1.8.2 (05-06-2025)
++++++++++++++++++

* Added RequestException handling for JSON content-type.

1.8.1 (04-14-2025)
++++++++++++++++++

* Updated request retries with support for 429 status code.
* Updated jira.py to check for JSON content-type in requests exceptions.

1.8.0 (01-13-2023)
++++++++++++++++++

* Added support in Jira for adding / removing watchers by email address.

1.7.0 (04-29-2022)
++++++++++++++++++

* Added support for kwargs to change_status() method in jira.py.

1.6.0 (12-02-2021)
++++++++++++++++++

* Added support for proxies in Jira.

1.5.0 (11-29-2021)
++++++++++++++++++

* Added support for personal access tokens in Jira.

1.4.5 (07-07-2020)
++++++++++++++++++

* Fixed RuntimeError in Python 3.8.
* Added support for trailing slash in URLs.
* Made verify requests to Jira tickets configurable.

1.4.4 (04-25-2019)
++++++++++++++++++

* Updated HTTP Basic Auth in ticket.py to disable SSL cert verification.

1.4.3 (01-08-2019)
++++++++++++++++++

* Added get_ticket_content() method to jira.py, rt.py, redmine.py, and
  bugzilla.py.
* Added add_attachment() method to servicenow.py.
* Added unit tests for ticket.py, jira.py, rt.py, redmine.py, and bugzilla.py.
* Added module-level loggers throughout all files.
* Added components support to Jira.
* Added support for creating subtasks in Jira.

1.3.0 (06-29-2017)
++++++++++++++++++

* New documentation has been created at http://ticketutil.readthedocs.io.
* All main user-accessible ticketutil methods now have useful return
  statements containing the request status (Success or Failure), the error
  message if the status is a Failure, and the URL of the ticket. See
  http://ticketutil.readthedocs.io/en/latest/Usage.html#return-statements
  for more details.
* HTTP Basic Auth support has been added to JIRA.

1.2.0 (04-28-2017)
++++++++++++++++++

* ServiceNow support has been added to ticketutil!

  - ticketutil/servicenow.py has been created, supporting main ticketing
    functions found in other tools.
  - tests/test_servicenow.py has been created, containing unit tests for
    servicenow.py.
  - Two new documentation files have been created: docs/servicenow.md and
    examples/servicenow_examples.md.

1.1.0 (04-18-2017)
++++++++++++++++++

* JIRA, Bugzilla, RT, Redmine

  - Added get_ticket_url() method to return ticket url for Ticket object.
  - Added get_ticket_id() method to return ticket id for Ticket object.
  - Added _verify_project() and _verify_ticket_id() methods to all tools.
    These methods are called when a new Ticket object is created to verify
    that the project and optional ticket_id parameters are valid.
  - Created TicketException class, which is raised if the url passed in
    during creation of a Ticket object can not be accessed. This exception
    is also raised if project or ticket_id can not be verified.
  - The environment variable TICKETUTIL_DEBUG has been replaced with
    TICKETUTIL_LOG_LEVEL, with a default value of 'INFO'. This allows you to
    turn on debug logging by setting this variable to 'DEBUG' and effectively
    turn off logging by setting it to 'CRITICAL'.

* JIRA

  - Modified _get_status_id() in jira.py to return the status_id
    corresponding to the state you are transitioning to, instead of the
    status_id corresponding to the transition itself.

* Bugzilla

  - Added add_attachment() method.
  - Added support for api_key authentication.
  - Added support for adding groups to ticket in create() and edit().

* RT

  - Added add_attachment() method.

* Redmine

  - Added add_attachment() method.

1.0.6 (01-20-2017)
++++++++++++++++++
- Trying to fix more PyPI issues.

1.0.5 (01-20-2017)
++++++++++++++++++
- Fixing README on PyPI.

1.0.4 (01-20-2017)
++++++++++++++++++
- Updated JIRA example and docstring to clarify that 'type' (and not
  'issuetype') is a supported create() and edit() field. No code changes.

1.0.3 (01-19-2017)
++++++++++++++++++
- First publish to PyPI!