bouwer.plugins package

Submodules

bouwer.plugins.Archive module

class bouwer.plugins.Archive.Archive

Bases: bouwer.plugin.Plugin

Generate an archive

Constructor

action_run(action)

Run the given action

execute_any(filename, include=['.'], exclude=[''])

Builder implementation

get_filelist(target, directory, include, exclude)

bouwer.plugins.CCheck module

bouwer.plugins.CCompiler module

class bouwer.plugins.CCompiler.CCompiler

Bases: bouwer.util.Singleton

Constructor

c_library(target, sources, item=None, depends=[])

Build a library using a target name and list of sources

c_object(source, item=None, depends=, []**extra_tags)

Compile a C source file into an object file

c_program(target, sources, item=None, depends=, []**extra_tags)

Build an program given its target name and sources list

use_library(libraries, target=None)

Build against a :py:`list` of libraries

The library target for linking will be discovered by searching the generated Action objects in the actions layer.

class bouwer.plugins.CCompiler.Include

Bases: bouwer.plugin.Plugin

Extend the C/C++ include path

Constructor

config_inputz___()

Configuration input items

config_output()

Configuration output items

execute_config_params(conf, includes)

Append includes to the incpath for CC.

class bouwer.plugins.CCompiler.Library

Bases: bouwer.plugin.Plugin

Build a software library

Constructor

config_input()

Configuration input items

config_output()

Configuration output items

execute_config(item, sources, depends=[])

Build a library using a Config and list of sources

execute_target(target, sources, depends=[])

Build a library using a target name and list of sources

class bouwer.plugins.CCompiler.LibraryObject

Bases: bouwer.plugin.Plugin

Specify an additional object for a library

Constructor

config_input()

Configuration input items

config_output()

Configuration output items

execute_config(item, sources, depends=[])

Build executable objects if configurion item item is True

execute_source(source, depends=[])

Build an executable object given its source file

class bouwer.plugins.CCompiler.Object

Bases: bouwer.plugin.Plugin

Build an executable object for a program.

Constructor

config_input()

Configuration input items

config_output()

Configuration output items

execute_config(item, sources, depends=[])

Build executable objects if configurion item item is True

execute_source(source, item=None, depends=[])

Build an executable object given its source file

class bouwer.plugins.CCompiler.Program

Bases: bouwer.plugin.Plugin

Build an executable program

Constructor

config_input()

Configuration input items

execute_config(item, sources, libraries=, []depends=, []name=None)

Build a program given a Config item and sources list.

execute_source(source)

Build an executable object given its source file

execute_target(target, sources, libraries=, []depends=, []item=None)

Build an program given its target name and sources list

class bouwer.plugins.CCompiler.UseLibrary

Bases: bouwer.plugin.Plugin

Build and link a program against a library

Constructor

config_input()

Configuration input items

config_output()

Configuration output items

execute_any(libraries)

Build against a :py:`list` of libraries

The library target for linking will be discovered internally.

execute_config_params(item, libraries)

bouwer.plugins.Check module

class bouwer.plugins.Check.CheckOS

Bases: bouwer.plugin.Plugin

Check for the target OS.

Constructor

action_event(action, event)

Called when an Action has finished

config_action_output()

execute_config_params(conf)

initialize()

bouwer.plugins.Command module

class bouwer.plugins.Command.Command

Bases: bouwer.plugin.Plugin

Run a shell command

Constructor

config_input()

execute_any(command)

Run a shell command

execute_config(item, sources, command, outfile=None)

Runs a command only if item is True

bouwer.plugins.ConfigHeader module

class bouwer.plugins.ConfigHeader.ConfigHeader

Bases: bouwer.plugin.Plugin

Output a C header file with Configuration encoded as #define’s

Constructor

action_event(action, event)

Called when an Action has finished

config_action_output()

config_input()

We can only write the config header when all items are final

execute_any(filename, prefix='CONFIG_')

Builder implementation for ConfigHeader()

bouwer.plugins.FullOutput module

class bouwer.plugins.FullOutput.FullOutput

Bases: bouwer.plugin.Plugin

Constructor

action_event(action, event)

initialize()

bouwer.plugins.Install module

class bouwer.plugins.Install.Install

Bases: bouwer.plugin.Plugin

Copy files to a new location

Constructor

action_run(action)

Run the given action

execute_any(stritem_dir, files)

Builder implementation

bouwer.plugins.LineConfig module

class bouwer.plugins.LineConfig.LineConfig

Bases: bouwer.plugin.Plugin

Configure using standard input

Constructor

configure(conf)

Main configuration routine

initialize()

Initialize plugin

bouwer.plugins.MenuConfig module

class bouwer.plugins.MenuConfig.ConfigBoolNode(value, parent=None, key=None, depth=None)

Bases: urwid.treetools.ParentNode

Represents a ConfigBool in urwid.

load_child_keys()

load_child_node(key)

load_widget()

class bouwer.plugins.MenuConfig.ConfigKeywordNode(value, parent=None, key=None, depth=None)

Bases: urwid.treetools.ParentNode

Represents a Config keyword.

load_child_keys()

load_widget()

class bouwer.plugins.MenuConfig.ConfigKeywordWidget(node)

Bases: urwid.treetools.TreeWidget

Represents a Config item keyword

get_display_text()

get_indented_widget()

keypress(size, key)

update()

class bouwer.plugins.MenuConfig.ConfigListNode(child, parent, key, depth, do_expand)

Bases: urwid.treetools.ParentNode

Represents a ConfigList in urwid.

load_child_keys()

load_child_node(key)

load_widget()

class bouwer.plugins.MenuConfig.ConfigListWidget(node)

Bases: urwid.treetools.TreeWidget

get_display_text()

get_indented_widget()

keypress(size, key)

update()

update_all()

class bouwer.plugins.MenuConfig.ConfigMenuWidget(node)

Bases: urwid.treetools.TreeWidget

class bouwer.plugins.MenuConfig.ConfigPathNode(value, parent=None, key=None, depth=None)

Bases: urwid.treetools.ParentNode

Represents a Bouwconfig path.

load_child_keys()

load_widget()

class bouwer.plugins.MenuConfig.ConfigPathWidget(node)

Bases: urwid.treetools.TreeWidget

get_display_text()

get_indented_widget()

selectable()

update()

class bouwer.plugins.MenuConfig.ConfigStringNode(value, parent=None, key=None, depth=None)

Bases: urwid.treetools.ParentNode

Represents a ConfigString in urwid.

load_child_keys()

load_widget()

class bouwer.plugins.MenuConfig.ConfigStringWidget(node)

Bases: urwid.treetools.TreeWidget

get_display_text()

get_indented_widget()

keypress(size, key)

update()

class bouwer.plugins.MenuConfig.ConfigTreeNode(value, parent=None, key=None, depth=None)

Bases: urwid.treetools.ParentNode

Represents a ConfigTree in urwid.

load_child_keys()

load_child_node(key)

load_widget()

class bouwer.plugins.MenuConfig.ConfigTreeWidget(node)

Bases: urwid.treetools.TreeWidget

Display widget for leaf nodes

get_display_text()

get_indented_widget()

keypress(size, key)

update()

update_all()

class bouwer.plugins.MenuConfig.ConfigurationNode(value, parent=None, key=None, depth=None)

Bases: urwid.treetools.ParentNode

Represents a Configuration in a urwid TreeList

load_child_keys()

load_child_node(key)

load_widget()

class bouwer.plugins.MenuConfig.DialogDisplay(text, height, width, body=None, loop=None, parent=None, caller=None)

Bases: builtins.object

add_buttons(buttons)

button_press(button)

on_exit(exitcode)

palette = [('body', 'black', 'light gray', 'standout'), ('border', 'black', 'dark blue'), ('shadow', 'white', 'black'), ('selectable', 'black', 'dark cyan'), ('focus', 'white', 'dark blue', 'bold'), ('focustext', 'light gray', 'dark blue')]

show()

unhandled_input(key)

exception bouwer.plugins.MenuConfig.DialogExit

Bases: builtins.Exception

class bouwer.plugins.MenuConfig.InputDialogDisplay(item, caller, height, width, parent, loop)

Bases: bouwer.plugins.MenuConfig.DialogDisplay

input_change(widget, text)

on_exit(exitcode)

class bouwer.plugins.MenuConfig.InputKeywordDialog(val, caller, height, width, parent, loop)

Bases: bouwer.plugins.MenuConfig.DialogDisplay

input_change(widget, text)

class bouwer.plugins.MenuConfig.MenuConfig

Bases: bouwer.plugin.Plugin

Configure using the urwid / ncurses text-console frontend

Constructor

configure(conf)

Configure using urwid

initialize()

Initialize the plugin

open_urwid_editor()

unhandled_input(k)

class bouwer.plugins.MenuConfig.TreeDialogDisplay(item, caller, height, width, parent, loop)

Bases: bouwer.plugins.MenuConfig.DialogDisplay

on_exit(exitcode)

bouwer.plugins.PrettyOutput module

class bouwer.plugins.PrettyOutput.PrettyOutput

Bases: bouwer.plugin.Plugin

Constructor

action_event(action, event)

initialize()

bouwer.plugins.ProgressBar module

class bouwer.plugins.ProgressBar.ProgressBar

Bases: bouwer.plugin.Plugin

Output a textual progress bar on the terminal

Constructor

action_event(action, event)

Called when an ActionEvent is triggered

get_console_width()

Return the width of the console in characters

initialize()

Initialize plugin

update_progress(progress, label='')

Displays or updates a console progress bar

bouwer.plugins.QuietOutput module

class bouwer.plugins.QuietOutput.QuietOutput

Bases: bouwer.plugin.Plugin

Outputs nothing unless an error occurs

Constructor

action_event(action, event)

Does nothing for quiet

initialize()

Initialize plugin

bouwer.plugins.RequireVersion module

class bouwer.plugins.RequireVersion.RequireVersion

Bases: bouwer.plugin.Plugin

Verify that Bouwer has the given minimum/maximum version.

Constructor

execute_any(minimum, maximum='9.9.9')

Builder implementation

Module contents