Package svnmailer :: Package notifier :: Module cia_xmlrpc

[hide private]

# Module cia_xmlrpc

source code

# CIA XML-RPC Notifier

This notifier delivers a notification message in XML format to a CIA server. The data delivered contains in particular:

- The timestamp of the revision
- Information about the generator (svnmailer)
- Information about the project (`cia_project_name`, `cia_project_module`, `cia_project_branch`, `cia_project_submodule`).
- Revision metadata:
  - author
  - revision number
  - log entry
  - summary URL (if `browser_base_url` if configured)
  - number of modified lines
- Information about the files modified (`cia_project_path` is stripped). If `browser_base_url` is supplied, it is used to generate an URI for each file.

The notifier runs only in the post-commit hook. For activation you need to supply the `cia_rpc_server` option in `[general]` and at least a `cia_project_name` in the group that should be tracked by CIA.

Author: Andr\xc3\xa9 Malo

Classes | [hide private]

| CIAXMLRPCNotifier The CIA XML-RPC Notifier class

Functions | [hide private]

`list`

getNotifier(config, groupset) Returns an initialized notifier or nothing | source code

Variables | [hide private]

| __package__ = ``'``svnmailer.notifier``'``

Function Details | [hide private]

### getNotifier(config, groupset)

source code

Returns an initialized notifier or nothing

Parameters:
  - `config` (`svnmailer.settings.Settings`) - The svnmailer config
  - `groupset` (`list`) - The groupset to process
Returns: `list`
  The list of notifiers (containing 0 or 1 member)