Package: canvas
Getting Startedpip install canvasUsage:$canvas[OPTIONS]COMMAND[ARGS]...Options:--no-ansi: Disable colorized output--version--verbose: Show extra output--install-completion: Install completion for the current shell.--show-completion: Show completion for the current shell, to copy it or customize the installation.--help: Show this message and exit.Commands:auth: Manage authenticating in Canvas instanceslogs: Listens and prints log streams from the instanceplugin: Manage plugins in a Canvas instanceprint-config: Print the config and exitcanvas authManage authenticating in Canvas instancesUsage:$canvasauth[OPTIONS]COMMAND[ARGS]...Options:--help: Show this message and exit.Commands:add-api-key: Add a host=api-key pair to the keychain, so it can be used in other requestsget-api-key: Print the api_key for the given hostremove-api-key: Removes a host from the keychain, and as the default if it's the oneset-default-host: Set the host as the default host in the config filecanvas auth add-api-keyAdd a host=api-key pair to the keychain, so it can be used in other requests.
Optionally set a default so--hostisn't required everywhereUsage:$canvasauthadd-api-key[OPTIONS]Options:--host TEXT: [required]--api-key TEXT: [required]--is-default / --no-is-default: [required]--help: Show this message and exit.canvas auth get-api-keyPrint the api_key for the given host.Usage:$canvasauthget-api-key[OPTIONS]HOSTArguments:HOST: [required]Options:--help: Show this message and exit.canvas auth remove-api-keyRemoves a host from the keychain, and as the default if it's the one.
This method always succeeds, regardless of username existence.Usage:$canvasauthremove-api-key[OPTIONS]HOSTArguments:HOST: [required]Options:--help: Show this message and exit.canvas auth set-default-hostSet the host as the default host in the config file. Validates it exists in the keychain.Usage:$canvasauthset-default-host[OPTIONS]HOSTArguments:HOST: [required]Options:--help: Show this message and exit.canvas logsListens and prints log streams from the instance.Usage:$canvaslogs[OPTIONS]Options:--host TEXT: Canvas instance to connect to--api-key TEXT: Canvas api-key for the provided host--help: Show this message and exit.canvas pluginManage plugins in a Canvas instanceUsage:$canvasplugin[OPTIONS]COMMAND[ARGS]...Options:--help: Show this message and exit.Commands:delete: Delete a disabled plugin from an instanceinit: Create a plugin from a template using Cookiecutterinstall: Installs a given Python package into a running Canvas instancelist: Lists all plugins from the instanceupdate: Updates a plugin from an instancecanvas plugin deleteDelete a disabled plugin from an instance.Usage:$canvasplugindelete[OPTIONS]NAMEArguments:NAME: Plugin name to delete [required]Options:--host TEXT: Canvas instance to connect to--api-key TEXT: Canvas api-key for the provided host--help: Show this message and exit.canvas plugin initCreate a plugin from a template using Cookiecutter.Usage:$canvasplugininit[OPTIONS][TEMPLATE]Arguments:[TEMPLATE]: [default: (dynamic)]Options:--no-input: Don't prompt the user at command line--help: Show this message and exit.canvas plugin installInstalls a given Python package into a running Canvas instance.Usage:$canvasplugininstall[OPTIONS]PACKAGEArguments:PACKAGE: Path to either a dir or wheel or sdist file containing the python package to install [required]Options:--host TEXT: Canvas instance to connect to--api-key TEXT: Canvas api-key for the provided host--help: Show this message and exit.canvas plugin listLists all plugins from the instance.Usage:$canvaspluginlist[OPTIONS]Options:--host TEXT: Canvas instance to connect to--api-key TEXT: Canvas api-key for the provided host--help: Show this message and exit.canvas plugin updateUpdates a plugin from an instance.Usage:$canvaspluginupdate[OPTIONS]NAMEArguments:NAME: Plugin name to update [required]Options:--package PATH: Path to a wheel or sdist file containing the python package to install--enable / --disable: Enable/disable the plugin--host TEXT: Canvas instance to connect to--api-key TEXT: Canvas api-key for the provided host--help: Show this message and exit.canvas print-configSimple command to print the config and exit.Usage:$canvasprint-config[OPTIONS]Options:--help: Show this message and exit.