Fabric with python 3

Welcome to 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. 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.

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

The project maintainer keeps a roadmap on his website.

This website covers project information for Fabric such as the changelog, contribution guidelines, and so forth. Detailed usage and API documentation can be found at our code documentation site, docs.fabfile.org.

Please see below for a high level intro, or the navigation on the left for the rest of the site content.

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', hide=True) >>> msg = "Ran  on , got stdout:\n " >>> print(msg.format(result)) Ran 'uname -s' on web1.example.com, got 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.

Fabric users may also be interested in two strictly optional libraries which implement best-practice user-level code: Invocations (Invoke-only, locally-focused CLI tasks) and Patchwork (remote-friendly, typically shell-command-focused, utility functions).

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

>>> from fabric import SerialGroup >>> result = SerialGroup('web1', 'web2').run('hostname') web1 web2 >>> # Sorting for consistency. it's a dict! >>> sorted(result.items()) [(, ), . ] 

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

>>> # NOTE: Same code as above! >>> def disk_free(c): . uname = c.run('uname -s', hide=True) . if 'Linux' in uname.stdout: . command = "df -h / | tail -n1 | awk ''" . return c.run(command, hide=True).stdout.strip() . err = "No idea how to get disk space on <>!".format(uname) . raise Exit(err) . >>> for cxn in SerialGroup('web1', 'web2', 'db1'): . print("<>: <>".format(cxn, disk_free(cxn))) : 33% : 17% : 2% 

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.

What is this website?¶

www.fabfile.org provides project information for Fabric such as the changelog, contribution guidelines, development roadmap, news/blog, and so forth.

Detailed conceptual and API documentation can be found at our code documentation site, docs.fabfile.org.

Источник

Installing¶

Users looking to install Fabric 1.x should see Installing (1.x) . However, upgrading to 2.x is strongly recommended.

Fabric is best installed via pip:

All advanced pip use cases work too, such as:

$ pip install -e git+https://github.com/fabric/fabric

Or cloning the Git repository and running:

Your operating system may also have a Fabric package available (though these are typically older and harder to support), typically called fabric or python-fabric . E.g.:

$ sudo apt-get install fabric

Installing modern Fabric as fabric2 ¶

Users who are migrating from Fabric 1 to Fabric 2+ may find it useful to have both versions installed side-by-side. The easiest way to do this is to use the handy fabric2 PyPI entry:

This upload is generated from the normal Fabric repository, but is tweaked at build time so that it installs a fabric2 package instead of a fabric one (and a fab2 binary instead of a fab one.) The codebase is otherwise unchanged.

Users working off of the Git repository can enable that same tweak with an environment variable, e.g.:

$ PACKAGE_AS_FABRIC2=yes pip install -e .

The value of the environment variable doesn’t matter, as long as it is not empty.

fabric and fabric2 vs fabric3 ¶

Unfortunately, the fabric3 entry on PyPI is an unauthorized fork of Fabric 1.x which we do not control. Once modern Fabric gets up to 3.x, 4.x etc, we’ll likely continue distributing it via both fabric and fabric2 for convenience; there will never be any official fabric3 , fabric4 etc.

In other words, fabric2 is purely there to help users of 1.x cross the 2.0 “major rewrite” barrier; future major versions will not be large rewrites and will only have small sets of backward incompatibilities.

Inability to pip install -e both versions¶

You may encounter issues if both versions of Fabric are installed via pip install -e , due to how that functionality works (tl;dr it just adds the checkout directories to sys.path , regardless of whether you wanted to “install” all packages within them — so Fabric 2+’s fabric/ package still ends up visible to the import system alongside fabric2/ ).

Thus, you may only have one of the local copies of Fabric installed in ‘editable’ fashion at a time, and the other must be repeatedly reinstalled via pip install (no -e ) if you need to make edits to it.

Order of installations¶

Due to the same pip quirk mentioned above, if either of your Fabric versions are installed in ‘editable’ mode, you must install the ‘editable’ version first, and then install the ‘static’ version second.

For example, if you’re migrating from some public release of Fabric 1 to a checkout of modern Fabric:

$ PACKAGE_AS_FABRIC2=yes pip install -e /path/to/fabric2 $ pip install fabric==1.14.0

You may see some warnings on that second pip install (eg Not uninstalling fabric or Can’t uninstall ‘fabric’ ) but as long as it exits cleanly and says something like Successfully installed fabric-1.14.0 , you should be okay. Double check with e.g. pip list and you should have entries for both fabric and fabric2 .

Dependencies¶

In order for Fabric’s installation to succeed, you will need the following:

• the Python programming language, versions 2.7 or 3.4+;
• the Invoke command-running and task-execution library;
• and the Paramiko SSH library (as well as its own dependencies; see its install docs.)

Development dependencies¶

If you are interested in doing development work on Fabric (or even just running the test suite), you’ll need the libraries listed in the dev-requirements.txt (included in the source distribution.) Usually it’s easy to simply pip install -r dev-requirements.txt .

Downloads¶

To obtain a tar.gz or zip archive of the Fabric source code, you may visit Fabric’s PyPI page, which offers manual downloads in addition to being the entry point for pip .

Source code checkouts¶

The Fabric developers manage the project’s source code with the Git DVCS. To follow Fabric’s development via Git instead of downloading official releases, you have the following options:

• Clone the canonical repository straight from the Fabric organization’s repository on Github (cloning instructions available on that page).
• Make your own fork of the Github repository by making a Github account, visiting fabric/fabric and clicking the “fork” button.

If you’ve obtained the Fabric source via source control and plan on updating your checkout in the future, we highly suggest using pip install -e . (or python setup.py develop ) instead – it will use symbolic links instead of file copies, ensuring that imports of the library or use of the command-line tool will always refer to your checkout.

For information on the hows and whys of Fabric development, including which branches may be of interest and how you can help out, please see the Development page.

Fabric

Pythonic remote execution

Источник

Fabric3 1.14.post1

Fabric is a simple, Pythonic tool for remote execution and deployment (py2.7/py3.4+ compatible fork).

Навигация

Ссылки проекта

Статистика

Метаданные

Лицензия: BSD License

Сопровождающие

Классификаторы

• Development Status
  • 5 — Production/Stable
  • Console
  • Developers
  • System Administrators
  • OSI Approved :: BSD License
  • MacOS :: MacOS X
  • POSIX
  • Unix
  • Python
  • Python :: 2
  • Python :: 2.7
  • Python :: 3
  • Python :: 3.4
  • Python :: 3.5
  • Software Development
  • Software Development :: Build Tools
  • Software Development :: Libraries
  • Software Development :: Libraries :: Python Modules
  • System :: Clustering
  • System :: Software Distribution
  • System :: Systems Administration

  Описание проекта

  Fabric3 is a fork of Fabric to provide compatability with Python 3.4+. The port still works with Python 2.7.

  The goal is to stay 100% compatible with the original Fabric. Any new releases of Fabric will also be released here. Please file issues for any differences you find. Known differences are documented on github .

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

  For more information, please see the Fabric website or execute fab —help .

  Источник

  Читайте также:  Python requests post file and data