Compatibility

This page describes the compatibility guarantees pyinfra offers.

pyinfra Versions

Where possible pyinfra follows semantic versioning rules. This means no breaking changes between minor versions (1.0 -> 1.1). Such changes are reserved for major version increases only. pyinfra will also generate warnings in CLI mode for any deprecated features due to be removed at the next major release. These are the pyinfra specific semver rules:

  • Major: breaking changes, warnings will show on latest previous major version

  • Minor: new operations, new APIs, new global arguments, deprecate & add warnings

  • Patch: new operation arguments for existing operations, bug fixes, documentation updates

Remote Systems

pyinfra aims to be compatible with all Unix-like operating systems and is currently tested against:

In general, the only requirement (beyond a SSH server) on the remote side is shell access. POSIX commands are used where possible for facts and operations, so most of the server and files operations should work anywhere POSIX.

Upgrading pyinfra from 0.x -> 1.x

The move to v1 removes a lot of old legacy functionality in pyinfra - there will be warnings written to the user in CLI mode if any of these are encountered. The full list can be seen on the changelog. In addition to these removals, v1 brings a few major changes and deprecates the old methods. Again, pyinfra will output warnings when these are encountered, and support will be removed in v2.

Rename the modules module

v1 has moved where operations are imported from to make more sense:

# Old, 0.x style:
from pyinfra.modules import server

# New, 1.x style:
from pyinfra.operations import server

Naming operations

v1 adds a global name argument to all operations. This replaces passing a set as the first argument which was confusing:

# Old, 0.x style:
server.shell(
    {'Execute some shell'},
    commands=['someshell'],
)

# New, 1.x style:
server.shell(
    name='Execute some shell',
    commands=['someshell'],
)