Skip to main content

pyinfra automates/provisions/manages/deploys infrastructure.

Project description

pyinfra

pyinfra turns Python code into shell commands and runs them on your servers. Execute ad-hoc commands and write declarative operations. Target SSH servers, local machine and Docker containers. Fast and scales from one server to thousands. Think ansible but Python instead of YAML, and a lot faster.


Getting StartedExamples RepoChat on Matrix

DocumentationHelp & SupportContributing


Why pyinfra? Design features include:

  • 🚀 Super fast execution over thousands of hosts with predictable performance.
  • 🚨 Instant debugging with realtime stdin/stdout/stderr output (-vvv).
  • 🔄 Idempotent operations that enable diffs and dry runs before making changes.
  • 📦 Extendable with the entire Python package ecosystem.
  • 💻 Agentless execution against anything with shell access.
  • 🔌 Integrated with connectors for Docker, Terraform, Vagrant and more.

Quickstart

Install pyinfra with pip:

pip install pyinfra

Now you can execute commands on hosts via SSH:

pyinfra my-server.net exec -- echo "hello world"

Or target Docker containers, the local machine, and other connectors:

pyinfra @docker/ubuntu exec -- echo "Hello world"
pyinfra @local exec -- echo "Hello world"

As well as executing commands you can define state using operations:

# Install iftop apt package if not present
pyinfra @docker/ubuntu apt.packages iftop update=true _sudo=true

Which can then be saved as a Python file like deploy.py:

from pyinfra.operations import apt

apt.packages(
    name="Ensure iftop is installed",
    packages=['iftop'],
    update=True,
    _sudo=True,
)

The hosts can also be saved in a file, for example inventory.py:

targets = ["@docker/ubuntu", "my-test-server.net"]

And executed together:

pyinfra inventory.py deploy.py

Now you know the building blocks of pyinfra! By combining inventory, operations and Python code you can deploy anything.

See the more detailed getting started or using operations guides. See how to use inventory & data, global arguments and the CLI or check out the documented examples.


PyPI version PyPi downloads Docs status Execute tests status Codecov Coverage MIT Licensed

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyinfra-3.1.1.tar.gz (198.5 kB view details)

Uploaded Source

Built Distribution

pyinfra-3.1.1-py2.py3-none-any.whl (255.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pyinfra-3.1.1.tar.gz.

File metadata

  • Download URL: pyinfra-3.1.1.tar.gz
  • Upload date:
  • Size: 198.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for pyinfra-3.1.1.tar.gz
Algorithm Hash digest
SHA256 5209a05897597c8747511bb559809a64a84377ae77424d3869d46583f95f2f30
MD5 7bc15956197eec09e97aa023c1fc9f2b
BLAKE2b-256 121cbb923dcd1ee29272e31986ef5f64e91b586a0c685efe82672f6cf468e96d

See more details on using hashes here.

File details

Details for the file pyinfra-3.1.1-py2.py3-none-any.whl.

File metadata

  • Download URL: pyinfra-3.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 255.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for pyinfra-3.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c87c75fcc03197ce84cb078838e225669be5cc0c4d4e52e408a9e774a3d183f6
MD5 c6472951115407e2738a9da6afd29988
BLAKE2b-256 a256cf53e42877039d13c3e07d63a38ce28e2cc4dca167a2cdc5420f2766f95a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page