tools.project package

Submodules

tools.project.incrementalArchive module

Module incrementalArchive: This module ...

class IncrementalArchiveMenuItem[source]

Bases: stkMariTools.lib.ui_utils.MariToolsMenuItem

This class adds a Clear History action.

The constructor.

Returns:
logger = <logging.Logger object>
archiveProject()[source]

This method incrementally archives the current project.

Returns:

tools.project.metadataManager module

Module metadataManager: This module contains classes for opening a metadata manager to manage the metadata on the current project in Mari.

class MetadataManagerMenuItem[source]

Bases: stkMariTools.lib.ui_utils.MariToolsMenuItem

This class adds the Metadata Manager action.

The constructor.

Returns:
openUi()[source]

This method launches the Metadata Manager UI

class MetadataManager(title='Metadata Manager')[source]

Bases: stkMariTools.lib.ui_utils.MariWidget

This class creates a Metadata Manager to manage metadata on Mari projects.

The constructor.

Parameters:title –
Returns:
defineUi()[source]

This method should be overloaded to handle defining the actual UI interface. It is run before populateData() and makeConnections().

Returns:
makeConnections(*args, **kwargs)[source]

This method handles connecting UI widgets to callbacks.

Parameters:
  • args –
  • kwargs –
Returns:

None
populateData(*args, **kwargs)[source]

This method populates UI with data.

Parameters:
  • args –
  • kwargs –
Returns:
refreshMetadata(project=None)[source]

This method populates/refreshes the metadata view with data.

Parameters:project –
Returns:
getMetadata(project=None)[source]

This method gets the current metadata on the project and returns it as a dict object.

Parameters:project –
Returns:dict containing the current metadata available in the project.
Return type:dict
resetToDefault(project=None, keep_non_standard_entries=True)[source]

This method resets all metadata to the original state that the project was saved in when first loaded.

Parameters:
  • project – Project instance of Mari ProjectManager
  • keep_non_standard_entries – bool that determines if added metadata entries should be removed
Returns:

None
removeNonStandardMetadata(project=None)[source]

This method removes all non-standard metadata entries from the given project.

Parameters:project –
Returns:
setMetadata()[source]

This method is called whenever the user changes the data in the metadata view and acts to apply the changes to the actual Mari project metadata.

Returns:
addMetadataEntry()[source]

This method adds a new metadata entry to the metadata view.

Returns:None
exportMetadataToFile()[source]

This method exports the current project metadata to a serialized file that can be loaded and applied to other projects.

Returns:
importMetadataFromFile()[source]

This method imports an existing metadata file and applies the data to the current project.

Returns:
checkForOpenProject()[source]

This method checks if a project is currently open in Mari.

Returns:bool indicating if project is open in Mari.
Return type:bool
staticMetaObject = <PySide.QtCore.QMetaObject object at 0x0000000006F8F408>

Module contents

Module __init__.py: This module ...