xiangqipy.app Namespace Reference

Contains a single function, run(), that does everything needed to play a Game. More...

Functions
GameSummary	run (Path custom_output_root=None, **Dict kwargs)
	Collects command line args, instantiates everything needed for a Game, runs the Game, and optionally saves GameSummary info.

Detailed Description

Contains a single function, run(), that does everything needed to play a Game.

Function Documentation

run()

GameSummary xiangqipy.app.run	(	Path	custom_output_root = None,
		**Dict	kwargs
	)

Collects command line args, instantiates everything needed for a Game, runs the Game, and optionally saves GameSummary info.

Parameters

custom_output_root	optional Path of output parent dir; if not specified, defaults to ./data/game_summaries/<timestamp-based-dirname>
**kwargs	optional key value pairs that can supplement or override command line args.

Definition at line 19 of file app.py.