mafw.scripts.cli.init

mafw.scripts.cli.init = <Command init>

Create a ready-to-use MAFw analysis project from the bundled template.

The command normalises the project name, validates it, renders the canonical template, writes the project atomically, and prints the commands needed to install and run the example. In interactive mode it prompts for any missing required value and for the optional description and Python version; with --non-interactive it never prompts. Use --with-storage to include an example logical storage volume; storage remains disabled by default.

Changed in version 2.4: Added the --with-storage and --without-storage options.

Parameters:

  • obj (dict) – The context object carrying the global options.

  • project_name (str | None) – The distribution name of the new project (hyphens allowed).

  • path (pathlib.Path | None) – The parent directory for the new project.

  • description (str | None) – An optional project description.

  • python_version (str | None) – An optional minimum Python version.

  • author_name (str | None) – An optional project author name.

  • author_email (str | None) – An optional project author e-mail address.

  • with_storage (bool) – Include an example logical storage volume.

  • non_interactive (bool) – Disable all prompting.

  • install (str | None) – Install the generated project with the given (or default) manager.

  • init_git (bool) – Initialise a Git repository in the generated project.