API reference¶

Configuration models¶

`SupervisorConfiguration`
`SupervisorConvenienceConfiguration`	Convenience layer, settings that MUST be set when running via convenience API
`SupervisordConfiguration`
`SupervisorctlConfiguration`
`ProgramConfiguration`
`EventListenerConfiguration`
`FcgiProgramConfiguration`
`GroupConfiguration`
`IncludeConfiguration`
`InetHttpServerConfiguration`
`RpcInterfaceConfiguration`
`UnixHttpServerConfiguration`
`load_config`([config_dir, config_name, ...])
`load_convenience_config`([config_dir, ...])

`SupervisorRemoteXMLRPCClient`(cfg)	A light wrapper over the supervisor xmlrpc api: http://supervisord.org/api.html
`ProcessInfo`
`ProcessState`(value)
`SupervisorState`(value)
`SupervisorMethodResult`(value)

`write_supervisor_config`(cfg_json[, _exit])	Write a SupervisorConvenienceConfiguration JSON as a supervisor config file
`start_supervisor`([cfg, _exit])	Start a supervisor instance using supervisord in background
`start_programs`([cfg, restart, _exit])	Start all programs in the supervisor instance
`check_programs`([cfg, check_running, ...])	Check if programs are in a good state.
`restart_programs`([cfg, force, _exit])	Restart all programs in the supervisor instance
`stop_programs`([cfg, _exit])	Stop all programs in the supervisor instance
`stop_supervisor`([cfg, _exit])	Stop the supervisor instance
`kill_supervisor`([cfg, _exit])	Kill the supervisor instance with os.kill
`remove_supervisor_config`([cfg, _exit])	Remove the supervisor config file and working directory