mloq.commands.project#

Mloq project command implementation.

Module Contents#

Classes#

ProjectCMD

Implement the functionality of the project Command.

Attributes#

PROJECT_ASSETS_PATH

readme

gitignore

pre_commit_hook

init

main

test_main

test_req

version

code_of_conduct

codecov

contributing

PROJECT_FILES

mloq.commands.project.PROJECT_ASSETS_PATH#
mloq.commands.project.readme#
mloq.commands.project.gitignore#
mloq.commands.project.pre_commit_hook#
mloq.commands.project.init#
mloq.commands.project.main#
mloq.commands.project.test_main#
mloq.commands.project.test_req#
mloq.commands.project.version#
mloq.commands.project.code_of_conduct#
mloq.commands.project.codecov#
mloq.commands.project.contributing#
mloq.commands.project.PROJECT_FILES#
class mloq.commands.project.ProjectCMD(record, interactive=False, **kwargs)[source]#

Bases: mloq.command.Command

Implement the functionality of the project Command.

Parameters
  • record (mloq.writer.CMDRecord) –

  • interactive (bool) –

cmd_name = project#
files#
disable#
project_name#
owner#
description#
project_url#
license#
tests#
property directories#

Tuple containing Paths objects representing the directories created by the command.

Return type

Tuple[pathlib.Path]

record_files()[source]#

Register the files that will be generated by mloq.

Return type

None