yawning_titan.main#

Provides a CLI using Typer as an entry point.

Functions

`build_dirs`	Build the Yawning-Titan app directories.
`clean_up`	Cleans up left over files from previous version installations.
`docs`	View the Yawning-Titan docs.
`gui`	Start the Yawning-Titan GUI.
`keyboard_agent`	Play Yawning-Titan using the Keyboard Agent.
`logs`	Print the Yawning-Titan log file.
`notebooks`	Start Jupyter Lab in the users Yawning-Titan notebooks directory.
`release_notes`	View the GitHub release notes of the installed Yawning-Titan version.
`reset_db`	Force a reset of the default entries in the NetworkDB and GameModeDB.
`reset_notebooks`	Force a reset of the default notebooks in the users notebooks directory.
`setup`	Perform the Yawning-Titan first-time setup.
`version`	Get the installed Yawning-Titan version number.

yawning_titan.main.build_dirs()[source]#: Build the Yawning-Titan app directories.

yawning_titan.main.reset_db(rebuild=False)[source]#

Force a reset of the default entries in the NetworkDB and GameModeDB.

Parameters:: rebuild – If True, completely rebuild the DB, removing all custom Networks and GameModes. Default value is False.

yawning_titan.main.reset_notebooks(overwrite=True)[source]#

Force a reset of the default notebooks in the users notebooks directory.

Parameters:: overwrite – If True, will overwrite existing default notebooks.

yawning_titan.main.logs(last_n=10)[source]#

Print the Yawning-Titan log file.

Parameters:: last_n – The number of lines to print. Default value is 10.

yawning_titan.main.notebooks()[source]#: Start Jupyter Lab in the users Yawning-Titan notebooks directory.

yawning_titan.main.version()[source]#: Get the installed Yawning-Titan version number.

yawning_titan.main.release_notes()[source]#: View the GitHub release notes of the installed Yawning-Titan version.

yawning_titan.main.clean_up()[source]#: Cleans up left over files from previous version installations.

yawning_titan.main.setup()[source]#

Perform the Yawning-Titan first-time setup.

WARNING: All user-data will be lost.

yawning_titan.main.keyboard_agent()[source]#: Play Yawning-Titan using the Keyboard Agent.