CLI¶

pychubby also offers a simple Command Line Interface that exposes some of the functionality of the Python package.

Usage¶

After installation of pychubby an entry point pc becomes available.

To see the basic information write pc --help:

Usage: pc [OPTIONS] COMMAND [ARGS]...

  Automated face warping tool.

Options:
  --help  Show this message and exit.

Commands:
  list     List available actions.
  perform  Take an action.

To perform actions one uses the perform subcommand. pc perform --help:

Usage: pc perform [OPTIONS] COMMAND [ARGS]...

  Take an action.

Options:
  --help  Show this message and exit.

Commands:
  Chubbify         Make a chubby face.
  LinearTransform  Linear transformation.
  OpenEyes         Open eyes.
  ...
  ...
  ...

The syntax for all actions is identical. The positional arguments are

Input image path (required)
Output image path (not required)

If the output image path is not provided the resulting image is simply going to be plotted.

All the options correspond to the keyword arguments of the constructor of the respective action classes in pychubby.actions module.

To give a specific example let us use the Smile action. To get info on the parameters write pc perform Smile --help:

Usage: pc perform Smile [OPTIONS] INP_IMG [OUT_IMG]

  Make a smiling face.

Options:
  --scale FLOAT
  --help         Show this message and exit.

In particular, one can then warp an image in the following fashion

pc perform Smile --scale 0.3 img_cousin.jpg img_cousin_smiling.jpg

Limitations¶

The features that are unavailable via the CLI are the following:

AbsoluteMove, Lambda and Pipeline actions
Different actions for different people
Lower level control

Specifically, if the user provides a photo with multiple faces the same action will be performed on all of them.