docs/Makefile docs/api.rst docs/conf.py docs/development.rst docs/downloads.rst docs/index.rst old-doc/samples/depends/fabfile.py old-doc/samples/fabfile.example old-doc/samples/roles/fabfile.py old-doc/samples/simple/fabfile.py old-doc/samples/transitives/fabfile.py old-doc/samples/variables/fabfile.py old-doc/site/api.py old-doc/site/bin/generate.py old-doc/site/bin/markdown2.py old-doc/site/bin/textile.py old-doc/site/bin/toc.py old-doc/site/common.css old-doc/site/community.md old-doc/site/documentation.md old-doc/site/download.txt old-doc/site/fabric-logo.svg old-doc/site/hacking.md old-doc/site/index.md old-doc/site/other-files old-doc/site/print.css old-doc/site/programmers_guide.txt old-doc/site/screen.css old-doc/site/source.txt old-doc/site/template.html old-doc/site/user_guide.md @@ -14,3 +14,4 @@ Fabric.egg-info release *.png .coverage +docs/_* .gitignore @@ -1,19 +1,16 @@ -FABRIC README. +Fabric is a Python library and command-line tool designed to streamline +deploying applications or performing system administration tasks via the SSH +protocol. It provides tools for running arbitrary shell commands (either as a +normal login user, or via ``sudo``), uploading and downloading files, and so +forth. -Fabric is a simple pythonic remote deployment tool. +Typical use involves defining a "fabfile" (a Python module) containing one or +more functions or tasks which may then be executed by the ``fab`` command-line +tool. Fabric provides extra functionality related to this mode of use, such as +prompting for user input, ensuring certain variables are present in order for +tasks to run, and specifying which host or hosts a specific task connects to by +default. -It is designed to upload files to, and run shell commands on, a number of -servers in parallel or serially. These commands are grouped in tasks (regular -python functions) and specified in a 'fabfile.' - -This is called remote automation, and the primary use case is deploying -applications to multiple similar hosts. - -Although it is easier to automate when the target hosts are similar, it is not -a requirement and Fabric has features for working with heterogeneous hosts as -well. - -Once installed, you can run `fab help` to learn more about how to use Fabric. - -If you want to make changes to the Fabric source code, then please see the -guide lines located here: http://www.nongnu.org/fab/hacking.html \ No newline at end of file +Fabric may also be used as a standalone library, so that other Python programs +needing a simple API on top of SSH or SCP may import and utilize specific +pieces of functionality. README @@ -1,7 +1,7 @@ """ -This module contains Fab's ``main()`` method plus related subroutines. +This module contains Fab's `main` method plus related subroutines. -``main()`` is executed as the command line ``fab`` program and takes care of +`main` is executed as the command line ``fab`` program and takes care of parsing options and commands, loading the user settings file, loading a fabfile, and executing the commands given. @@ -254,10 +254,10 @@ def get_hosts(cli_hosts, command): The list of hosts a given command will run on follows a strict order of precedence: - 1. Hosts specified via the command line (e.g. ``fab foo:hosts='a;b;c'``) - 1. Hosts specified via the ``@hosts`` and ``@roles`` decorators - 1. Hosts specified globally via the command line (TODO: "let" syntax) - 1. Hosts specified globally by setting ``env.hosts`` at module level in + #. Hosts specified via the command line (e.g. ``fab foo:hosts='a;b;c'``) + #. Hosts specified via the ``@hosts`` and ``@roles`` decorators + #. Hosts specified globally via the command line (TODO: "let" syntax) + #. Hosts specified globally by setting ``env.hosts`` at module level in the fabfile (note: since fabfiles are fully loaded, the last line to set ``env.hosts`` is the line that wins) @@ -299,6 +299,9 @@ def get_hosts(cli_hosts, command): def main(): + """ + Main command-line execution loop. + """ try: try: # Parse command line options fabric/main.py @@ -6,3 +6,4 @@ nose coverage pylint -e hg+http://bitbucket.org/kumar303/fudge/#egg=Fudge +Sphinx >= 0.6 requirements.txt @@ -3,39 +3,24 @@ from setuptools import setup setup( - name = 'Fabric', - version = __import__('fabric').get_version() - description = 'Fabric is a simple, Pythonic tool for remote execution and deployment.', - long_description = """ -Fabric is designed to streamline the process of interacting with remote -servers, typically via SSH, for the purposes of deploying applications or -performing system administration tasks. It provides tools for running arbitrary -shell commands (either as a normal login user, or via ``sudo``), uploading and downloading files, and so forth. - -Typical use involves defining a "fabfile", a Python module defining one or more -functiona/tasks, which may then be executed (one or more at a time) by the -``fab`` command-line tool. Fabric provides extra functionality related to this -mode of use, such as prompting for user input, ensuring certain variables are -present in order for tasks to run, and specifying which host or hosts a -specific task connects to by default. - -Fabric may also be used as a standalone library, so that other Python programs -needing a simple API on top of SSH or SCP may import and utilize specific -pieces of Fabric functionality. - -For more information, please see the project website, or ``fab --help``. + name='Fabric', + version=__import__('fabric').get_version(), + description='Fabric is a simple, Pythonic tool for remote execution and deployment.', + long_description=open('README').read() + """ + +For more information, please see the Fabric website or execute ``fab --help``. """, - author = 'Jeff Forcier', - author_email = 'jeff@bitprophet.org', - url = 'http://fabfile.org', - install_requires = ['paramiko >=1.7, <2.0'], - py_modules = ['fabric'], - entry_points = { + author='Jeff Forcier', + author_email='jeff@bitprophet.org', + url='http://fabfile.org', + install_requires=['paramiko >=1.7, <2.0'], + py_modules=['fabric'], + entry_points={ 'console_scripts': [ 'fab = fabric.main:main', ] }, - classifiers = [ + classifiers=[ 'Development Status :: 3 - Alpha', 'Environment :: Console', 'Intended Audience :: Developers', setup.py doc/samples/depends/fabfile.py doc/samples/fabfile.example doc/samples/roles/fabfile.py doc/samples/simple/fabfile.py doc/samples/transitives/fabfile.py doc/samples/variables/fabfile.py doc/site/api.py doc/site/bin/generate.py doc/site/bin/markdown2.py doc/site/bin/textile.py doc/site/bin/toc.py doc/site/common.css doc/site/community.md doc/site/documentation.md doc/site/download.txt doc/site/fabric-logo.svg doc/site/hacking.md doc/site/index.md doc/site/other-files doc/site/print.css doc/site/programmers_guide.txt doc/site/screen.css doc/site/source.txt doc/site/template.html doc/site/user_guide.md 6a22869a74a3e5a207e11f39f481555c7702c091 Jeff Forcier jeff@bitprophet.org http://github.com/karmazilla/fabric/commit/88badcfc1cb0e9a689b59f83e81087e1bf6106cf 88badcfc1cb0e9a689b59f83e81087e1bf6106cf 2009-04-25T15:40:36-07:00 2009-04-25T15:40:36-07:00 Started in with Sphinx in a big way. Totally not done yet but groundwork here. d98abf739b7cc3613639c485155565ba20b179d1 Jeff Forcier jeff@bitprophet.org