Local Connector

# Execute on local machine
pyinfra @local apt.packages nginx update=true _sudo=true

# Run deploy file locally
pyinfra @local deploy.py

# Install package locally
pyinfra @local apt.packages curl _sudo=true

# Run shell commands
pyinfra @local server.shell "echo 'Hello from local'"

# Execute deploy
pyinfra @local deploy.py

# inventory.py
hosts = ["@local"]

# inventory.py
hosts = ["@local"]

# deploy.py
from pyinfra import host
from pyinfra.operations import apt, files, systemd
from pyinfra.facts.server import LinuxDistribution

# Get local system info
distro = host.get_fact(LinuxDistribution)
print(f"Configuring local {distro['name']} {distro['version']} system")

# Update system
apt.update(
    name="Update apt cache",
    _sudo=True,
)

# Install development tools
apt.packages(
    name="Install dev tools",
    packages=[
        "build-essential",
        "git",
        "curl",
        "vim",
    ],
    _sudo=True,
)

# Create project directory
files.directory(
    name="Create projects directory",
    path="~/projects",
    present=True,
)

# Configure git
files.line(
    name="Set git user.name",
    path="~/.gitconfig",
    line="[user]",
    present=True,
)

files.line(
    name="Set git user.email",
    path="~/.gitconfig",
    line="\temail = [email protected]",
    present=True,
)

# Execute locally with sudo
pyinfra @local deploy.py

# setup_dev.py
from pyinfra.operations import apt, pip, git, files

# Install system packages
apt.packages(
    name="Install system dependencies",
    packages=[
        "python3",
        "python3-pip",
        "python3-venv",
        "postgresql",
        "redis-server",
    ],
    _sudo=True,
)

# Clone project
git.repo(
    name="Clone project repository",
    src="https://github.com/user/project.git",
    dest="~/projects/project",
)

# Create virtualenv
pip.virtualenv(
    name="Create Python virtualenv",
    path="~/projects/project/venv",
)

# Install Python dependencies
pip.packages(
    name="Install Python packages",
    packages=["requirements.txt"],
    virtualenv="~/projects/project/venv",
)

# ci_setup.py
from pyinfra.operations import apt, files

# Install build tools
apt.packages(
    name="Install CI tools",
    packages=[
        "docker.io",
        "ansible",
        "terraform",
    ],
    _sudo=True,
)

# Create workspace
files.directory(
    name="Create CI workspace",
    path="/workspace",
    present=True,
    _sudo=True,
)

# test_deploy.py
from pyinfra.operations import server

# Test command locally
server.shell(
    name="Test command",
    commands=["ls -la /tmp"],
)

# Test locally first
pyinfra @local test_deploy.py

# Then deploy to production
pyinfra inventory.py test_deploy.py

# inventory.py
hosts = [
    "@local",
    "web1.example.com",
    "web2.example.com",
]

# deploy.py
from pyinfra import host
from pyinfra.operations import files

if host.name == "@local":
    # Local-specific operations
    files.directory(
        name="Create local logs directory",
        path="~/logs",
    )
else:
    # Remote-specific operations
    files.directory(
        name="Create remote logs directory",
        path="/var/log/app",
        _sudo=True,
    )

# Install system package
apt.packages(
    name="Install nginx",
    packages=["nginx"],
    _sudo=True,  # Uses sudo
)

# Create file in home directory (no sudo needed)
files.file(
    name="Create user file",
    path="~/test.txt",
    content="Hello",
)

from pyinfra import Config, Inventory, State
from pyinfra.api import add_op
from pyinfra.operations import server

# Create inventory with local host
inventory = Inventory(
    (["@local"], {})
)

config = Config(SUDO=True)
state = State(inventory, config)
state.init(inventory, config)

# Connect
for host in inventory:
    host.connect()

# Add operations
add_op(
    state,
    server.shell,
    commands=["uname -a"],
)

# Execute
from pyinfra.api.operations import run_ops
run_ops(state)

# This command
server.shell(commands=["ls /tmp"])

# Becomes
import subprocess
subprocess.run(["sh", "-c", "ls /tmp"])

# With sudo
server.shell(commands=["ls /tmp"], _sudo=True)

# Becomes
subprocess.run(["sudo", "-H", "-n", "sh", "-c", "ls /tmp"])

from pyinfra import Config
from pyinfra.operations import server

config = Config(
    ENV={
        "PATH": "/custom/bin:$PATH",
        "MY_VAR": "value",
    }
)

server.shell(
    name="Command with env",
    commands=["echo $MY_VAR"],
)

from pyinfra.operations import server

server.shell(
    name="Long running command",
    commands=["./long_script.sh"],
    _timeout=300,  # 5 minute timeout
)