CLI Parser.
Handsdown API Index / Handsdown / Cli Parser
Auto-generated documentation for handsdown.cli_parser module.
Show source in cli_parser.py:16
Main CLI Namespace.
class CLINamespace: ...Show source in cli_parser.py:36
Get URL to source code.
URL as a string.
def get_source_code_url(self) -> str: ...Show source in cli_parser.py:88
Validate path_str and make it absolute.
path_str- A path to check.
An absolute path.
def abs_path(path_str: str) -> Path: ...Show source in cli_parser.py:102
Validate directory path_str and make it absolute.
path_str- A path to check.
An absolute path.
argparse.ArgumentTypeError- If path is not a directory.
def dir_abs_path(path_str: str) -> Path: ...Show source in cli_parser.py:123
Validate existing directory path_str and make it absolute.
path_str- A path to check.
An absolute path.
argparse.ArgumentTypeError- If path does not exist or is not a directory.
def existing_dir_abs_path(path_str: str) -> Path: ...Show source in cli_parser.py:58
Validate git_repo_url to be a GitHub repo and converts SSH urls to HTTPS.
git_repo_url- GitHub URL orremote.origin.url
A GitHub URL.
def git_repo(git_repo_url: str) -> str: ...Show source in cli_parser.py:164
Get CLI arguments parser.
An argparse.ArgumentParser instance.
def parse_args(args: Iterable[str]) -> CLINamespace: ...Show source in cli_parser.py:147
Cast theme name to Theme.
def parse_theme(name: str) -> Theme: ...