High level SSH command execution

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for bitprophet from gravatar.com bitprophet

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Project description

To find out what’s new in this version of Fabric, please see the changelog.

What is Fabric?

Fabric is a high level Python (2.7, 3.4+) library designed to execute shell commands remotely over SSH, yielding useful Python objects in return:

>>> from fabric import Connection
>>> result = Connection('web1.example.com').run('uname -s')
>>> msg = "Ran {.command!r} on {.connection.host}, got stdout:\n{.stdout}"
>>> print(msg.format(result))
Ran "uname -s" on web1.example.com, got this stdout:
Linux

It builds on top of Invoke (subprocess command execution and command-line features) and Paramiko (SSH protocol implementation), extending their APIs to complement one another and provide additional functionality.

How is it used?

Core use cases for Fabric include (but are not limited to):

  • Single commands on individual hosts:

    >>> result = Connection('web1').run('hostname')
web1
>>> result
<Result cmd='hostname' exited=0>

  • Single commands across multiple hosts (via varying methodologies: serial, parallel, etc):

    >>> result = SerialGroup('web1', 'web2').run('hostname')
web1
web2
>>> result
{<Connection host=web1>: <Result cmd='whoami' exited=0>, ...}

  • Python code blocks (functions/methods) targeted at individual connections:

    >>> def disk_free(c):
>>>     uname = c.run('uname -s', hide=True)
>>>     if 'Linux' in uname:
...         command = "df -h / | tail -n1 | awk '{print $5}'"
...         return c.run(command, hide=True).stdout.strip()
...     err = "No idea how to get disk space on {}!".format(uname)
...     raise Exit(err)
...
>>> disk_free(Connection('web1'))
'33%'

  • Python code blocks on multiple hosts:

    >>> def disk_free(c):
...     # same as above!
...
>>> {c: disk_free(c) for c in SerialGroup('web1', 'web2', 'db1')}
{<Connection host=web1>: '33%', <Connection host=web2>: '17%', ...}

In addition to these library-oriented use cases, Fabric makes it easy to integrate with Invoke’s command-line task functionality, invoking via a fab binary stub:

  • Python functions, methods or entire objects can be used as CLI-addressable tasks, e.g. fab deploy;

  • Tasks may indicate other tasks to be run before or after they themselves execute (pre- or post-tasks);

  • Tasks are parameterized via regular GNU-style arguments, e.g. fab deploy --env=prod -d;

  • Multiple tasks may be given in a single CLI session, e.g. fab build deploy;

  • Much more - all other Invoke functionality is supported - see its documentation for details.

I’m a user of Fabric 1, how do I upgrade?

We’ve packaged modern Fabric in a manner that allows installation alongside Fabric 1, so you can upgrade at whatever pace your use case requires. There are multiple possible approaches – see our detailed upgrade documentation for details.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for bitprophet from gravatar.com bitprophet

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

3.2.2

3.2.1

3.2.0

3.1.0

3.0.1

3.0.0

2.7.1

2.7.0

2.6.0

2.5.0

2.4.0

2.3.2

2.3.1

2.3.0

2.2.3

2.2.2

2.2.1

2.2.0

2.1.6

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.1.0

2.0.5

2.0.4

This version

2.0.3

2.0.2

2.0.1

2.0.0

1.15.0

1.14.1

1.14.0

1.13.2

1.13.1

1.13.0

1.12.2

1.12.1

1.12.0

1.11.3

1.11.2

1.11.1

1.11.0

1.10.5

1.10.4

1.10.3

1.10.2

1.10.1

1.10.0

1.9.2

1.9.1

1.9.0

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.4

1.6.2

1.6.1

1.6.0

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.8

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.8

1.1.7

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

0.9.7

0.9.6

0.9.5

0.9.4

0.9.3

0.9.2

0.9.1

0.9.0

0.1.1

0.1.0

0.0.9

0.0.8

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

0.0.1

Download files

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

Source Distribution

fabric-2.0.3.tar.gz (137.9 kB view details)

Uploaded Source

Built Distribution

fabric-2.0.3-py2.py3-none-any.whl (38.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file fabric-2.0.3.tar.gz.

File metadata

  • Download URL: fabric-2.0.3.tar.gz
  • Upload date:
  • Size: 137.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for fabric-2.0.3.tar.gz
Algorithm Hash digest
SHA256 dae6154d43e610d356c46ccce9b7b25b461e455fb238ff9e5566b8163521eb05
MD5 7ec9fe260cbcae6e0247e7c48cc571ad
BLAKE2b-256 58b522e15fa6c6a9a43fed34a5efb15f17e362b044c55f02afc1195ec518a223

See more details on using hashes here.

File details

Details for the file fabric-2.0.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for fabric-2.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 38ef20813bcff0d89214599258051034622c5676fc8739c6c191e4943439e25a
MD5 0f34dba188560eb7f74a15a1af9bbd04
BLAKE2b-256 4e4243a68677105f08613fed97a80eaaafa984312fbdea45d3162a6e491c85ea

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