pyziggy.cli

Used by the pyziggy command line program.

Functions

main([args])

The entry point of the pyziggy command-line program.

pyziggy.cli.main(args: list[str] | None = None) → None

The entry point of the pyziggy command-line program.

You can import and call this function in a Python script as an alternative to directly running the command-line program.

Important

The run subcommand requires the path of a Python module file that instantiates the DevicesClient object – i.e. the file that contains the devices = AvailableDevices() line.

It will then import this module file and identify the DevicesClient object.

Because of this import mechanism you can’t call pyziggy.cli.main() in the same file that you are trying to import by passing it to the run subcommand.

Parameters:

args – The same arguments that you would pass on the command line to the pyziggy program. For a complete list see Command-line reference.