roachcase package

Module contents

The API for roachcase

roachcase.add_player(player: str) → None

Register a player to the roachcase

roachcase.list_players() → List[str]

List all players registered to the roachcase

roachcase.set_persistence(persistence: str = 'memory', path: str | Path | None = None) → None

Set/Reset where data should persist.

Parameters:

• [persistence] – how to store the data. Available options are: “memory”, “shelf”.

• [path] – Optional path to the file for persistence. Will be created if does not exist

With persistence = “memory”, data will be lost at the end of a session. With persistence = “shelf”, path must be set, and data will be persisted as a shelf/pickle database