1.0.16

Version 1.0.16

• Feature: The Pyblish CLI is back!
• API: Added pyblish.api.sort()
• API: Added pyblish.api.current_host()
• API: Plug-in paths can no longer be modified by altering
  the results returned from pyblish.api.plugin_paths()
• API: Paths are no longer made absolute during registration.

CLI

You can now invoke Pyblish from the command-line.

$ pyblish --help
Usage: pyblish [OPTIONS] COMMAND [ARGS]...

  Pyblish command-line interface

  Use the appropriate sub-command to initiate a publish.

  Use the --help flag of each subcommand to learn more about what it can
  do.

  Usage:
      $ pyblish publish --help
      $ pyblish test --help

Options:
  --verbose                       Display detailed information. Useful for
                                  debugging purposes.
  --version                       Print the current version of Pyblish
  --paths                         List all available paths
  --plugins                       List all available plugins
  --registered-paths              Print only registered-paths
  --environment-paths             Print only paths added via environment
  --configured-paths              Print only paths added via configuration
  -pp, --plugin-path TEXT         Replace all normally discovered paths with
                                  this This may be called multiple times.
  -ap, --add-plugin-path TEXT     Append to normally discovered paths.
  -c, --config TEXT               Absolute path to custom configuration file.
  -d, --data TEXT...              Initialise context with data. This takes
                                  two arguments, key and value.
  -ll, --logging-level [debug|info|warning|critical|error]
                                  Specify with which level to produce logging
                                  messages. A value lower than the default
                                  'warning' will produce more messages. This
                                  can be useful for debugging.
  --help                          Show this message and exit.

Commands:
  config   List available config.
  publish  Publish instances of path.

Available sub-commands are:

• publish
• config

$ pyblish publish --help
Usage: pyblish publish [OPTIONS] [PATH]

  Publish instances of path.

  Arguments:
      path: Optional path, either absolute or relative,
          at which to initialise a publish. Defaults to
          the current working directory.

  Usage:
      $ pyblish publish my_file.txt --instance=Message01
      $ pyblish publish my_file.txt --all

Options:
  -i, --instance TEXT  Only publish specified instance. The default behaviour
                       is to publish all instances. This may be called
                       multiple times.
  -de, --delay FLOAT   Add an artificial delay to each plugin. Typically used
                       in debugging.
  --help               Show this message and exit.

Custom Data

You can add data to the Context from the command-line as well, here's an example of how that works.

$ pyblish --data key value --data key2 value2 publish

Each time --data is called, with it's two arguments (key, value), each item is added to the Context before plug-ins start running.