TkDependencyManager.TkDependencyManager Class Reference

UI for dependencies. More...

Inheritance diagram for TkDependencyManager.TkDependencyManager:

Public Member Functions
def	__init__ (self, parent, dependencies, module, gui)
def	addManager (self)
def	checkDependencies (self)
def	success (self)
def	failure (self)
def	OnInstallClick (self)
def	loadCache (self)
def	installRequired (self)
def	isInstalled (self, dependency)
def	open (self)
def	close (self)

Public Attributes
	widgets
	variables
	dependencies
	module
	gui
	notifier
	aptGet
	pip
	colours
	images
	fonts
	widget
	gridrow
	cache
	cachepath
	cachefile

Detailed Description

UI for dependencies.

Constructor & Destructor Documentation

__init__()

def TkDependencyManager.TkDependencyManager.__init__	(		self,
			parent,
			dependencies,
			module,
			gui
	)

Initializes the TkDependencyManager object
example values for dependencies:
    single dependency: { 'package': 'nmap', 'installer': 'apt-get' }
    multi dependency: [{ 'package': 'tk8.5-dev', 'installer': 'apt-get' }, { 'package': 'pillow', 'installer': 'pip', 'version': 'latest' }]
    
@param parent Frame
@param dependencies dict or list of dicts
@param module: the name of the module which initialized the package manager
@param gui reference to the GUI object

Member Function Documentation

addManager()

def TkDependencyManager.TkDependencyManager.addManager

(

self

)

called by requesting module if install / upgrade is required

checkDependencies()

def TkDependencyManager.TkDependencyManager.checkDependencies

(

self

)

view - displays the result of the dependency checks

close()

def TkDependencyManager.TkDependencyManager.close

(

self

)

removes the dependency manager

failure()

def TkDependencyManager.TkDependencyManager.failure

(

self

)

view - displays in the event of an unsuccessful installation

installRequired()

def TkDependencyManager.TkDependencyManager.installRequired

(

self

)

returns a bool indicating whether or not any dependencies require installation

@return bool

isInstalled()

def TkDependencyManager.TkDependencyManager.isInstalled	(		self,
			dependency
	)

returns status: 0 = not installed, 1 = upgrade required, 2 = installed

@param dependency

@return int

loadCache()

def TkDependencyManager.TkDependencyManager.loadCache

(

self

)

initialises the dependency cache either with stored data or an empty dict 

OnInstallClick()

def TkDependencyManager.TkDependencyManager.OnInstallClick

(

self

)

action - performs installation

open()

def TkDependencyManager.TkDependencyManager.open

(

self

)

displays the dependency manager

success()

def TkDependencyManager.TkDependencyManager.success

(

self

)

view - displays in the event of a successful installation

---

The documentation for this class was generated from the following file:

• TkDependencyManager.py