API Documentation

Model definitions can be found in the pycoshark models.

core

The core module contains the abstract base class for labeling approaches and the LabelSHARK class which provides the rough plugin structure for approaches.

class core.BaseLabelApproach

Abstract base class for labeling approaches.

class core.LabelSHARK

LabelSHARK plugin structure.

This class calls every registered labeling approach plugin.

classmethod approach(approach)

Registers an approach with LabelSHARK.

Should be used with the @LabelSHARk.approach decorator on the class implementing the approach.

get_labels()

Calls every registered commit labeling approach to collect the labels.

Every collected label is prefixed with the name of the approach.

set_commit(commit)

Passes the current commit model to the approach class.

Parameters

commit (obj) – A Commit object from pycoshark models.

smartshark_plugin

Plugin for execution with serverSHARK.

smartshark_plugin.main(args)