enbasics package

Subpackages

• enbasics.badges package
  • Submodules
  • enbasics.badges.badges module
    • Badge
      • Badge.html
      • Badge.write()
  • enbasics.badges.common module
  • Module contents
    • Badge
      • Badge.html
      • Badge.write()
• enbasics.execution package
  • Submodules
  • enbasics.execution.badges module
    • arguments()
    • operation()
    • execution()
  • Module contents
• enbasics.makefile package
  • Submodules
  • enbasics.makefile.makefile module
    • makeout()
    • makeread()
    • makefile()
  • Module contents
    • makefile()
    • makeout()
    • makeread()

Module contents

enbasics.makefile(path: Path | str = 'Makefile', *, name: str | None = None, version: str | None = None, method: Literal['stdout', 'print'] = 'stdout', color: int | None = 7) → None

Print the Makefile summary in the human friendly format.

Parameters:

• path – Complete or relative path to the makefile.

• name – Name of the project to show in the console.

• version – Version of projects to show beside name.

• method – Which method for standard output is used.

• color – Optional color override default ANSI gray.

enbasics.makeout(string: str, prefix: Literal['text', 'base', 'more'] | None = None, method: Literal['stdout', 'print'] = 'stdout', color: int | None = 7) → None

Print the ANSI colorized string to the standard output.

Note

This function is forgiving due to use with Makefile.

Parameters:

• string – String processed using inline directives.

• prefix – Determine if and which prefix prepended.

• method – Which method for standard output is used.

• color – Optional color override default ANSI gray.

enbasics.makeread(path: Path | str) → str

Return the contents using the provided filesystem path.

Parameters:

path – Complete or relative path to the makefile.

Returns:

Contents using the provided filesystem path.