API reference

This page holds mloq API documentation, which might be helpful for final users or developers to create their own mloq-based utilities. Among the different sub-packages and modules, we might differentiate two big categories: core utilities and high-level ones.

• Core API: This routines are located within the mloq.api that show the different features of the library can be accessed programmatically.

• mloq
  • Subpackages
    • mloq.commands
      • Submodules
        • mloq.commands.ci
        • mloq.commands.docker
        • mloq.commands.docs
        • mloq.commands.globals
        • mloq.commands.license
        • mloq.commands.lint
        • mloq.commands.package
        • mloq.commands.project
        • mloq.commands.requirements
        • mloq.commands.setup
      • Package Contents
        • Classes
    • mloq.config
      • Submodules
        • mloq.config.configuration
        • mloq.config.custom_click
        • mloq.config.param_patch
        • mloq.config.prompt
  • Submodules
    • mloq.__main__
    • mloq._utils
      • Module Contents
        • Functions
    • mloq.cli
      • Module Contents
        • Classes
        • Functions
        • Attributes
    • mloq.command
      • Module Contents
        • Classes
    • mloq.custom_click
      • Module Contents
        • Functions
        • Attributes
    • mloq.failure
      • Module Contents
        • Failure
        • MissingConfigValue
    • mloq.files
      • Module Contents
        • Classes
        • Functions
        • Attributes
    • mloq.git
      • Module Contents
        • Functions
    • mloq.record
      • Module Contents
        • Classes
    • mloq.runner
      • Module Contents
        • Functions
    • mloq.templating
      • Module Contents
        • Functions
        • Attributes
    • mloq.version
      • Module Contents
        • __version__
    • mloq.writer
      • Module Contents
        • Classes
  • Package Contents
    • _logger