view detectors/README.txt @ 5695:3e1b66c4e1e2

Update docs. Correct errors reported by setup.py build_docs. Add rest interface and link to rest doc to features page. Add link to xmlrpc doc to features page. Add rest doc to index. Update rest doc, hopefully clarify confusing use of parameters in patch action section. Fix code examples in "Adding new rest endpoints" section. Fix example adding import of exception.
author John Rouillard <rouilj@ieee.org>
date Sun, 07 Apr 2019 20:17:52 -0400
parents ec06bd6ea156
children b2eb59ada444
line wrap: on
line source

This directory has some detector examples that you can use to get
ideas on implementing your own detectors.

These are provides on an as-is basis. When they were added, they
worked for somebody and were considered a useful example.

The roundup team will attempt to keep them up to date with major
changes as they happen, but there are no guarantees that these will
work out of the box. If you find them out of date and have patches to
make them work against newer versions of roundup, please open an issue
at:

   http://issues.roundup-tracker.org

The current inventory is:

creator_resolution.py - only allow the creator of the issue to resolve it

emailauditor.py - Rename .eml files (from email multi-part bodies) to
                  .mht so they can be downloaded/viewed in Internet Explorer.

irker.py - communicate with irkerd to allow roundtup to send announcements
           to an IRC channel.

newissuecopy.py - notify a team email address (hardcoded in the script)
		  when a new issue arrives.

newitemcopy.py - email the DISPATCHER address when new issues, users,
                 keywords etc. are created. Kind of an expanded version
		 of newissuecopy.

Roundup Issue Tracker: http://roundup-tracker.org/