Navigation

  • index
  • modules |
  • next |
  • previous |
  • Home »
pyinfra.com GitHub
pyinfra latest

Using pyinfra

  • Getting Started
  • Writing Deploys
  • Using the CLI
  • Packaging Deploys

Deploy Reference

  • Operations Index
  • Facts Index
  • Example Deploys
  • Connectors

How pyinfra Works

  • Executing Deploys
  • Writing Operations
  • Writing Facts
  • Building Connectors
  • Using the API
  • API Reference
    • pyinfra.api.command module
    • pyinfra.api.config module
    • pyinfra.api.connect module
    • pyinfra.api.connectors package
    • pyinfra.api.connectors.ansible module
    • pyinfra.api.connectors.chroot module
    • pyinfra.api.connectors.docker module
    • pyinfra.api.connectors.dockerssh module
    • pyinfra.api.connectors.local module
    • pyinfra.api.connectors.mech module
    • pyinfra.api.connectors.ssh module
    • pyinfra.api.connectors.sshuserclient package
    • pyinfra.api.connectors.sshuserclient.client module
    • pyinfra.api.connectors.sshuserclient.config module
    • pyinfra.api.connectors.util module
    • pyinfra.api.connectors.vagrant module
    • pyinfra.api.connectors.winrm 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.operation_kwargs module
    • pyinfra.api.operations module
    • pyinfra.api.state module
    • pyinfra.api.util module
    • pyinfra.local module
    • pyinfra.modules module
    • pyinfra.progress module
    • pyinfra.pseudo_modules module
    • pyinfra.version module

Meta

  • Help & Support
  • Contributing
  • Compatibility
  • Performance

Documentation may contain unreleased features!

You are reading most recent documentation which may not have been released yet. 1.x is the latest release version available.

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.command module
  • pyinfra.api.config module
  • pyinfra.api.connect module
  • pyinfra.api.connectors package
  • pyinfra.api.connectors.ansible module
  • pyinfra.api.connectors.chroot module
  • pyinfra.api.connectors.docker module
  • pyinfra.api.connectors.dockerssh module
  • pyinfra.api.connectors.local module
  • pyinfra.api.connectors.mech module
  • pyinfra.api.connectors.ssh module
  • pyinfra.api.connectors.sshuserclient package
  • pyinfra.api.connectors.sshuserclient.client module
  • pyinfra.api.connectors.sshuserclient.config module
  • pyinfra.api.connectors.util module
  • pyinfra.api.connectors.vagrant module
  • pyinfra.api.connectors.winrm 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.operation_kwargs module
  • pyinfra.api.operations module
  • pyinfra.api.state module
  • pyinfra.api.util module
  • pyinfra.local module
  • pyinfra.modules module
  • pyinfra.progress module
  • pyinfra.pseudo_modules module
  • pyinfra.version module
  • ← Using the API
  • pyinfra.api.command module →

Navigation

  • index
  • modules |
  • next |
  • previous |
  • Home »