API Documentation¶

class aaarrghh.index.ProjectIndex(indexfile=None)[source]¶

Class that represents a project index.

dump_index(filename=None, fp=None)[source]¶

Dump the index.

Parameters:	filename (str) – Name of file into which the index will be written. fp – If sepcified, the index will be dumped to the file-like object specified. Otherwise, it will be dumped to the file from which it was loaded.

dumps_index()[source]¶

Return a string representation of the index

load_index(filename=None, fp=None)[source]¶

Load the index

Parameters:	filename (str) – File from which the index is loaded. If None, the file name specified in self.filename is used. If self.filename is None, an empty index is created. fp – File like object from which to read the data.