Source

restontrac / trac-dev / restontrac / README

Full commit

= Publish Trac data via a REST-ful interface =

 RESTful interface built on top of Trac XmlRpcPlugin

== !ToDo ==

Outstanding tasks are :

[[TicketQuery(component=plugin_restontrac&priority=major, format=list, rows=id|summary)]]

== Dependencies ==

This plugin depends on the following components to be installed:


  - [http://undefined.org/python/#simplejson simplejson] . For Python<2.6


== Installation ==

This plugin has been tested with 
[http://trac.edgewall.org/ Trac]  [http://trac.edgewall.org/wiki/1.0 1.0] .  You can see it in action [http://blood-hound.net here] . 

The first step to make it work is to [wiki:TracPlugins install this plugin] 
either for a particular environment or otherwise make it available to
all the environments:

{{{
$ easy_install /path/to/unpacked/RestOnTrac-x.y.z.zip
}}}

,, where ''x.y.z'' is the version of the plugin,,

... or alternately ...

{{{
$ easy_install RestOnTrac
}}}

In case of having internet connection and access to 
[http://pypi.python.org/pypi PyPI] or a simlar repository, both these 
methods '''should''' automatically retrieve the [#Dependencies external 
dependencies] from there.

== Configuration ==

In order to enable [wiki:/En/Devel/RestOnTrac RestOnTrac] plugin, 
the only thing to do is to add the following lines to [wiki:TracIni trac.ini].

{{{
[components]
tracrest.* = enabled
}}}

== Bug / feature requests ==

Existing bugs and feature requests for [wiki:/En/Devel/RestOnTrac RestOnTrac] are
[query:status=new|assigned|reopened&component=plugin_restontrac here].
If you have any issues, please create a [/newticket?component=plugin_restontrac new ticket].