module __init__

Short summary

module pyquickhelper

Module pyquickhelper. Helpers to produce documentation, test notebooks, walk through files, sphinx extension, jenkins helpers…

source on GitHub

Functions

function	truncated documentation
check	Checks the library is working. It raises an exception if it does not.
get_fLOG	return a logging function
get_insetup_functions	Returns function used when a module includes C++ parts.
load_ipython_extension	to allow the call %load_ext pyquickhelper

Documentation

Module pyquickhelper. Helpers to produce documentation, test notebooks, walk through files, sphinx extension, jenkins helpers…

source on GitHub

pyquickhelper.check()

Checks the library is working. It raises an exception if it does not.

Returns:

boolean

source on GitHub

pyquickhelper.get_fLOG(log=True)

return a logging function

Parameters:

log – True, return fLOG, otherwise noLOG()

Returns:

function

source on GitHub

pyquickhelper.get_insetup_functions()

Returns function used when a module includes C++ parts.

Returns:

tuple of functions

source on GitHub

pyquickhelper.load_ipython_extension(ip)

to allow the call %load_ext pyquickhelper

Parameters:

ip – from get_ipython()

source on GitHub