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

This version

3.2

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.2.tar.gz (209.7 kB view details)

Uploaded Source

Built Distribution

pyinfra-3.2-py2.py3-none-any.whl (269.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for pyinfra-3.2.tar.gz
Algorithm Hash digest
SHA256 ea65f2048860dae6a7d86470d4a7ca67c9e2e82d671e781b849f1e5e163ad6db
MD5 1a494f430772d5e38becbd14aef2705e
BLAKE2b-256 e35e5dbbda367708cd34ac5a3a0d18c352ae0eee01bfd0077e23350f4c07972f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyinfra-3.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 269.7 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.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ca8e6f4b51031b3b56b4ab6e7ce4cb749530ec92d6ba22f1f2657e2d20231416
MD5 575657703b1b7712913d96763fbb3f96
BLAKE2b-256 83b0a27ce89ec525e71180b0afa1069fb83886381c834c009d07802616af9b6e

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 Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page