scripts

Start the command line program.

Classes⚓︎

Functions⚓︎

parse_ttt_args ⚓︎

parse_ttt_args(*, seed_file='', version=False, uninstall=False)

Practice Touch Typing in your terminal.

PARAMETER	DESCRIPTION
`seed_file`	Optional path to seed file used for generating the prompt. TYPE: `str` DEFAULT: `''`
`version`	Show program’s version number and exit. TYPE: `bool \| None` DEFAULT: `False`
`uninstall`	Remove all files created by tui-typer-tutor. TYPE: `bool \| None` DEFAULT: `False`

Source code in tui_typer_tutor/scripts.py

@arguably.command
def parse_ttt_args(
    *,
    seed_file: str = '',
    version: bool | None = False,
    uninstall: bool | None = False,
) -> None:
    """Practice Touch Typing in your terminal.

    Args:
        seed_file: Optional path to seed file used for generating the prompt.
        version: Show program's version number and exit.
        uninstall: Remove all files created by tui-typer-tutor.

    """
    if version:
        logger.text('Version', pkg_name=__pkg_name__, version=__version__)
    elif uninstall:
        run_uninstall()
    else:
        config = get_config()
        if seed_file:
            config.seed_file = Path(seed_file)
        TuiTyperTutor().run()

start ⚓︎

start()

CLI Entrypoint.

Source code in tui_typer_tutor/scripts.py

@beartype
def start() -> None:
    """CLI Entrypoint."""
    arguably.run()