cook-builder 0.5.0

Build script aggregator and remote executor

Cook

Local and remote shell commands executor written and configured in Python

Quickstart

Installation

Cook is available on PyPI as cook-builder. The recommended way is to install it using pipx:

pipx install cook-builder

Recipe Reference

Cook uses recipe.py files to store project configuration.

Check out the Examples for a reference on recipe.py format and features.

For a dry run use: cook --dry.

To select project and/or build server interactively run: cook -i.

Generating Recipe Template

To generate a recipe template for your project, run:

cook -t

You can open the created recipe.py file and adjust the projects/commands to your needs.

Running Cook

Simply use the cook command to run the recipe file:

cook

To see all available command-line options, use:

cook --help

VS Code recipe autocomplete

If cook is installed via pipx, VS Code's Pylance won't find it for autocomplete by default. Add the following to your User settings:

{
    "python.analysis.extraPaths": [
        "~/.local/share/pipx/venvs/cook-builder/lib/python3.12/site-packages"
    ]
}

Adjust the Python version in the path if needed.

To find the venvs path on your system, run:

pipx environment --value PIPX_LOCAL_VENVS