API Reference

The pyinfra API is designed like this:

• A set of classes storing state

  • pyinfra.api.State
  • pyinfra.api.Inventory
  • pyinfra.api.Host
  • pyinfra.api.Config

• A set of modules that implement functionality:

  • operation.py & operations.py
  • ssh.py
  • facts.py

Core API

• pyinfra.api.arguments module
• pyinfra.api.command module
• pyinfra.api.config module
• pyinfra.api.connect module
• pyinfra.api.connectors module
• pyinfra.api.deploy module
• pyinfra.api.exceptions module
• pyinfra.api.facts module
• pyinfra.api.host module
• pyinfra.api.inventory module
• pyinfra.api.operation module
• pyinfra.api.operations module
• pyinfra.api.state module
• pyinfra.api.util module
• pyinfra.connectors package
• pyinfra.connectors.ansible module
• pyinfra.connectors.chroot module
• pyinfra.connectors.docker module
• pyinfra.connectors.dockerssh module
• pyinfra.connectors.local module
• pyinfra.connectors.mech module
• pyinfra.connectors.pyinfrawinrmsession package
• pyinfra.connectors.ssh module
• pyinfra.connectors.sshuserclient package
• pyinfra.connectors.sshuserclient.client module
• pyinfra.connectors.sshuserclient.config module
• pyinfra.connectors.terraform module
• pyinfra.connectors.util module
• pyinfra.connectors.vagrant module
• pyinfra.connectors.winrm module
• pyinfra.context module
• pyinfra.local module
• pyinfra.progress module
• pyinfra.version module