styx-api/CLI to Boutiques

Create a Boutiques descriptor for a Python CLI based on `argparse` or `click`

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stale
License: None

Inputs

name	description	required	default
parser-type	Type of parser to serialize. Either "argparse" or "click".	yes	argparse
parser-location	Module path to and name of function that produces the argparse.ArgumentParser or click.Command objects. E.g., "my_package.my_module:my_func_name"	yes	—
prog-name	Program name to use. Highly recommended if the name is not explicitly set in the parser source code.	no	—
output-path	Where the output Boutiques description file should be written	yes	—
open-pr	Whether to open a pull request with the generated descriptor. If this is set to true (default), a GitHub token must be provided as well.	no	true
token	GitHub token with write permissions for "contents" and "pull-requests". Required if open-pr is true.	no	—
click-parent-location	Module path to and name of function that produces the click.Group object that contains the click.Command object to serialize. E.g., "my_package.my_module:my_func_name". This is needed for nested commands.	no	—
exclude-version	Whether to exclude the tool-version field in the Boutiques descriptor even if version information is available. This is enabled by default because dynamic versioning schemes can cause the descriptor to be updated on every commit.	no	true
updates-file	Path to a JSON file with updates to apply to the generated Boutiques descriptor. The file should contain a map of dot/bracket paths to values (e.g. {"description": "new desc"}).	no	—
updates-str	JSON string with updates to apply to the generated Boutiques descriptor. The string should contain a map of dot/bracket paths to values (e.g. {"description": "new desc"}). Updates specified this way will override those in the updates file.	no	—
validate	Whether to validate the generated Boutiques descriptor. If this is set to true, the action will fail if the descriptor is invalid.	no	false
click-prog-name	Program name to use for the Click parser type. By default this will be the name of the decorated function.	no	—

Outputs

no outputs