create_brandon.scripts package

Submodules

create_brandon.scripts.helper_functions module

create_brandon.scripts.helper_functions.create_parent_name(date_today, fridge_name=None, device_name=None, experiment_name=None)

Create name of project Will be used as folder name and name of jupyter notebook unless stated otherwise Relies on the date today

Parameters

  • date_today (string) – _description_

  • fridge_name (string, optional) – Defaults to None.

  • device_name (string, optional) – Defaults to None.

  • experiment_name (string, optional) – Defaults to None.

Returns

Name of project (<date>_<fridge_name>_<device_name>_<experiment_name>)

Return type

string

create_brandon.scripts.helper_functions.initialise_notebook(notebook_name=None, directory=None, content=None)

Create Jupyter notebook named of name notebook_name in the directory directory with content in the cells.

Parameters

  • notebook_name (string, optional) – Name of Jupyter notebook.

  • None. (Defaults to) –

  • directory (string, optional) – Name of directory containing new

  • None (Defaults to) –

  • content (string, optional) – Content of new Jupyter notebook.

  • None –

create_brandon.scripts.helper_functions.speak_friend_and_enter(input_arg_list=[None], verbose_list=['-verbose', '-v'])

Brandon introduces itself, and asks the user their name. This function is a bit of an Easter egg and is to simulate the opening scene of The Matrix - Wake up Neo.

Parameters

  • input_arg_list (list, optional) – Command line arguments passed by the user. Defaults to [None].

  • verbose_list (list, optional) – Required list of arguments to trigger conversation from Brandon. Defaults to [“-verbose”, “-v”].

create_brandon.scripts.helper_functions.type_to_terminal(output, typing_speed=100, deviation=10)

Type text in commmand line as though being typed by a human.

Parameters

  • output (string) – Text to be typed in the command line

  • typing_speed (int, optional) – Typing speed of computer. Defaults to 70.

  • deviation (int, optional) – Deviation of typing speed (Guassian distribution). Defaults to 5.

create_brandon.scripts.helper_functions.wpm_to_cps(typing_speed)

Convert words per minute to characters per second Assumes that 1 word per minute is the same as 5 characters per second

Parameters

typing_speed (float) – Typing Speed in Words per minute

Returns

typing speed in characters per second

Return type

float

Module contents