proj_flow.minimal.init

The proj_flow.minimal.init implements proj-flow init command.

proj_flow.minimal.init.main(project: ~typing.Annotated[str, ~proj_flow.api.arg.Argument(help=~proj_flow.minimal.init._project_help, pos=True, names=[], nargs=None, opt=None, meta=project, action=None, default=None, choices=~proj_flow.minimal.init._project_types, completer=None, group=None)], path: ~typing.Annotated[str | None, ~proj_flow.api.arg.Argument(help=Location of initialized project. The directory will be created, if it does not exist yet. Defaults to current directory., pos=True, names=[], nargs=None, opt=None, meta=None, action=None, default=., choices=None, completer=None, group=None)], non_interactive: ~typing.Annotated[bool, ~proj_flow.api.arg.FlagArgument(help=Selects all the default answers., pos=False, names=['-y', '--yes'], nargs=None, opt=True, meta=None, action=store_true, default=False, choices=None, completer=None, group=ExclusiveArgumentGroup(opt=True))], store: ~typing.Annotated[str | None, ~proj_flow.api.arg.Argument(help=Do not create project, store the context in given file., pos=False, names=[], nargs=None, opt=None, meta=context-file, action=None, default=None, choices=None, completer=None, group=ExclusiveArgumentGroup(opt=True))], answers: ~typing.Annotated[str | None, ~proj_flow.api.arg.Argument(help=Take all the answers from the answer sheet., pos=False, names=[], nargs=None, opt=None, meta=context-file, action=None, default=None, choices=None, completer=None, group=ExclusiveArgumentGroup(opt=True))], save_context: ~typing.Annotated[bool, ~proj_flow.api.arg.FlagArgument(help=Save the mustache context as YAML., pos=False, names=['--ctx'], nargs=None, opt=True, meta=None, action=store_true, default=False, choices=None, completer=None, group=None)], rt: ~proj_flow.api.env.Runtime)

Initialize new project

Call:

proj-flow init

Call:

./flow init

Parameters:

  • project (str) – <function _project_help at 0x769aa6a0db10>

  • path (str | None) – Location of initialized project. The directory will be created, if it does not exist yet. Defaults to current directory.

  • non_interactive (bool) – Selects all the default answers.

  • store (str | None) – Do not create project, store the context in given file.

  • answers (str | None) – Take all the answers from the answer sheet.

  • save_context (bool) – Save the mustache context as YAML.

  • rt (Runtime) – Tools and print messages, while respecting --dry-run, --silent and --verbose.