trac-ticketrpc 0.9.3

Trac JSON RPC plugin for ticket management

trac-ticketrpc

Trac plugin to handle JSON RPC requests for ticket creation, update and details.
Documentation

Report Bug · Request Feature

About The Project

The plugin is intended as an interface for software development tools which want to use Trac as an external bug tracker.
It allows to create a new Trac ticket, post comments for a ticket, read details of a ticket and close an existing ticket.
Project was triggered, because I wanted to use Trac from Kiwi test case management system.

Changelog

v0.9.3 (15 Jul 2025)

• Return Trac ticket ID in response to ticket details request

v0.9.2 (11 Jul 2025)

• Return full ticket details in response to ticket creation request

v0.9.1 (5 Jul 2025)

• initial Release

Getting Started

Prerequisites

The plugin needs Python, version 3.7 or higher and Trac, version 1.6 or higher.

Installation

1. Make sure you are working on the local Python installation used by your trac server, eventually activate appropriate virtual environment

2. pip install trac_ticketrpc

3. Enable plugin by adding the following in affected trac.ini files:

   [components]
   tracticketrpc.rpctickethandler.rpctickethandler = enabled

4. Restart Trac server

JSON RPC API

All HTTP requests must be issued using method 'POST' and contain header attributes 'Content-type'='application/json' and 'Accept'='application/json'.
Make sure to supply a session cookie for methods changing Trac repository. This can be achieved by sending an HTTP GET request with valid credentials to Trac-Server-URL/project-name/login before the RPC request, but in the same session.
The plugin supports the methods listed below.

• Create new ticket

  method: 'ticket.create'
  mandatory parameter: 'summary', 'description', 'project'
  optional parameter: 'priority', 'version', 'component'
  result: Trac ticket data as returned by ticket details

• Add ticket comment

  method: 'ticket.add_comment'
  mandatory parameter: 'id', 'text', 'project'
  result: 'id'=Trac ticket ID, 'cnum'=comment number

• Close ticket

  method: 'ticket.close'
  mandatory parameter: 'id', 'resolution', 'project'
  optional parameter: 'text'
  result: 'id'=Trac ticket ID

• Get ticket details

  method: 'ticket.details'
  mandatory parameter: 'id', 'project'
  result: 'id', 'summary', 'reporter', 'owner', 'description', 'type', 'status', 'priority',
  'milestone', 'component', 'version', 'keywords', 'cc', 'time', 'changetime'

• Get ticket comments

  method: 'ticket.comments'
  mandatory parameter: 'id', 'project'
  result: 'id', 'comments'

Contributing

Any contributions are greatly appreciated.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Frank Sommer - [e-mail]

Project Link: https://github.com/FrankSommer-64/trac-ticketrpc