aquin.license_display Namespace Reference

Functions
None	render_license_document (*, str context="view", bool show_acceptance_footer=False)
bool	prompt_license_acceptance (*, str context="first_use")

Variables
	_BANNER = BANNER
	_width = width
	_rule = rule
	_center = center
	_center_block = center_block
	_box_line = box_line
	_box_lines = box_lines
	_box_top = box_top
	_box_bottom = box_bottom
	_ascii_safe = ascii_safe

Function Documentation

prompt_license_acceptance()

bool prompt_license_acceptance	(	*	,
		str	context = "first_use" )

Show the full license and ask the user to accept.

Definition at line 84 of file license_display.py.

References render_license_document().

render_license_document()

None render_license_document	(	*	,
		str	context = "view",
		bool	show_acceptance_footer = False )

Print the full license in a consistent ASCII frame.

Definition at line 40 of file license_display.py.

Referenced by prompt_license_acceptance().

Variable Documentation

_ascii_safe

aquin.license_display._ascii_safe = ascii_safe

protected

Definition at line 37 of file license_display.py.

_BANNER

aquin.license_display._BANNER = BANNER

protected

Definition at line 28 of file license_display.py.

_box_bottom

aquin.license_display._box_bottom = box_bottom

protected

Definition at line 36 of file license_display.py.

_box_line

aquin.license_display._box_line = box_line

protected

Definition at line 33 of file license_display.py.

_box_lines

aquin.license_display._box_lines = box_lines

protected

Definition at line 34 of file license_display.py.

_box_top

aquin.license_display._box_top = box_top

protected

Definition at line 35 of file license_display.py.

_center

aquin.license_display._center = center

protected

Definition at line 31 of file license_display.py.

_center_block

aquin.license_display._center_block = center_block

protected

Definition at line 32 of file license_display.py.

_rule

aquin.license_display._rule = rule

protected

Definition at line 30 of file license_display.py.

_width

aquin.license_display._width = width

protected

Definition at line 29 of file license_display.py.