kumade 0.3.0

A make-like build utility for Python.

kumade

A make-like build utility for Python.

Features:

• You can define tasks, such as executing commands, creating files, or invoking functions, in Kumadefile.py, with standard Python code.
• You can run tasks from shell with kumade command.
• Any task can have its dependencies and kumade considers the dependency graph to determin the task execution order.
• Kumade decides whether or not to perform a file creation task with considering the file existence and whether its timestamp is older than its dependencies.
• You can add configuration items in Kumadefile.py, and specify the values from command line when executing tasks. (v0.2.0 ~)
• Kumade can execute tasks concurrently using the -j option. (v0.3.0 ~)

Kumade means rake in Japanese, and it is regarded as a lucky charm because it collects happiness.

Getting started

Install

To install kumade, use pip:

pip install kumade

Write Kumadefile.py

To define tasks, write Kumadefile.py.

For example,

import kumade as ku

from pathlib import Path
import subprocess

ku.set_default("greet")

help_file = Path("help.txt")

@ku.task("greet")
@ku.depend(help_file)
def greeting() -> None:
    print("Hi, this is Kumade.")
    print(f"See {help_file}.")

@ku.file(help_file)
def create_help_file() -> None:
    with help_file.open("w") as outfile:
        subprocess.run(["kumade", "-h"], stdout=outfile)

This example defines two tasks and sets default task.

The task "greet" is defined by the decorator @ku.task("greet") and it will output a greeting when executed. This task depends on the file "help.txt" and kumade will execute the file creation task if it does not exist.

The file creation task for "help.txt" is defined by the decorator @ku.file(help_file) and it will create the file by capturing the standard output of command execution.

You can see more examples of task definition in the file Kumadefile.py in the kumade repository.

Run

To run tasks from shell, use kumade command:

kumade

kumade command loads task definitions from Kumadefile.py and runs the specified tasks (or the default task if no task is specified).

Run kumade --help to see available options.

For development

Install

You can install this package from GitHub directly:

pip install git+ssh://[e-mail]/yamaimo/kumade.git

Or, to develop, install from a cloned repository as follows:

# clone repository
git clone [e-mail]:yamaimo/kumade.git
cd kumade

# create venv and activate it
python3.11 -m venv venv
source venv/bin/activate

# install this package as editable with dependencies
pip install -e .[develop]

Format and Lint

To format, execute kumade format.

To lint, execute kumade lint.

Unit test

To run unit test, execute kumade test.

If you want verbose output, execute kumade test_verbose=true test.

If you want to run each test file, execute kumade test_each=true path/to/test_file.py

Coverage

To measure coverage and report it, execute kumade coverage.