Module Expr Str ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad body Expr Str Assign NameStore BinOpMod Str NameLoad If CompareIsNot NameLoad NameLoad body Assign NameStore BinOpAdd NameLoad BinOpMod Str NameLoad If BoolOpAnd NameLoad CompareIs NameLoad NameLoad body Expr Call NameLoad NameLoad orelse If NameLoad body Expr Call NameLoad NameLoad keyword NameLoad orelse Expr Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad body Expr Str If CompareIs NameLoad NameLoad body Raise Call NameLoad Str If NameLoad body Assign NameStore BinOpMod Str TupleLoad NameLoad NameLoad orelse Assign NameStore BinOpMod Str TupleLoad NameLoad NameLoad With Call NameLoad NameLoad body If BoolOpAnd NameLoad CompareIs NameLoad NameLoad body Expr Call NameLoad NameLoad orelse If NameLoad body Expr Call NameLoad NameLoad keyword NameLoad orelse Expr Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad body Expr Str If CompareIs NameLoad NameLoad body Raise Call NameLoad Str If CompareIsNot NameLoad NameLoad body Assign NameStore BinOpMod Str NameLoad orelse Assign NameStore Str With Call NameLoad NameLoad body If BoolOpAnd NameLoad CompareIs NameLoad NameLoad body Expr Call NameLoad NameLoad orelse If NameLoad body Expr Call NameLoad NameLoad keyword NameLoad orelse Expr Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad body Expr Str If CompareIs NameLoad NameLoad body Raise Call NameLoad Str Assign NameStore ListLoad If NameLoad body Expr Call AttributeLoad NameLoad attr Str Assign NameStore Call AttributeLoad Str attr NameLoad Assign NameStore BinOpMod Str NameLoad With Call NameLoad NameLoad body If BoolOpAnd NameLoad CompareIs NameLoad NameLoad body Expr Call NameLoad NameLoad orelse If NameLoad body Expr Call NameLoad NameLoad keyword NameLoad orelse Expr Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults Str NameLoad NameLoad NameLoad body Expr Str If CompareIs NameLoad NameLoad body Raise Call NameLoad Str Assign NameStore ListLoad If NameLoad body Expr Call AttributeLoad NameLoad attr Str Assign NameStore Call AttributeLoad Str attr NameLoad Assign NameStore BinOpMod Str TupleLoad NameLoad NameLoad With Call NameLoad NameLoad body If BoolOpAnd NameLoad CompareIs NameLoad NameLoad body Expr Call NameLoad NameLoad orelse If NameLoad body Expr Call NameLoad NameLoad keyword NameLoad orelse Expr Call NameLoad NameLoad decorator_list
N/A N/A 
Git
===

This module provides low-level tools for managing `Git`_ repositories.  You
should normally not use them directly but rather use the high-level wrapper
:func:`fabtools.require.git.working_copy` instead.

.. _Git: http://git-scm.com/

 fabric.api run fabric.api sudo fabric.context_managers cd fabtools.utils run_as_root clone N/A N/A remote_url path use_sudo user N/A None False None N/A N/A 
    Clone a remote Git repository into a new directory.

    :param remote_url: URL of the remote repository to clone.
    :type remote_url: str

    :param path: Path of the working copy directory.  Must not exist yet.
    :type path: str

    :param use_sudo: If ``True`` execute ``git`` with
                     :func:`fabric.operations.sudo`, else with
                     :func:`fabric.operations.run`.
    :type use_sudo: bool

    :param user: If ``use_sudo is True``, run :func:`fabric.operations.sudo`
                 with the given user.  If ``use_sudo is False`` this parameter
                 has no effect.
    :type user: str
     N/A cmd N/A git clone --quiet %s remote_url N/A N/A path None N/A N/A cmd N/A cmd N/A  %s path N/A N/A use_sudo N/A user None N/A N/A N/A run_as_root cmd N/A N/A use_sudo N/A N/A N/A sudo cmd user user N/A N/A N/A run cmd N/A add_remote N/A N/A path name remote_url use_sudo user fetch N/A False None True N/A N/A 
    Add a remote Git repository into a directory.

    :param path: Path of the working copy directory.  This directory must exist
                 and be a Git working copy with a default remote to fetch from.
    :type path: str

    :param use_sudo: If ``True`` execute ``git`` with
                     :func:`fabric.operations.sudo`, else with
                     :func:`fabric.operations.run`.
    :type use_sudo: bool

    :param user: If ``use_sudo is True``, run :func:`fabric.operations.sudo`
                 with the given user.  If ``use_sudo is False`` this parameter
                 has no effect.
    :type user: str

    :param name: name for the remote repository
    :type name: str

    :param remote_url: URL of the remote repository
    :type remote_url: str

    :param fetch: If ``True`` execute ``git remote add -f``
    :type fetch: bool
     N/A N/A path None N/A N/A N/A ValueError Path to the working copy is needed to add a remote N/A fetch N/A N/A cmd N/A git remote add -f %s %s N/A name remote_url N/A N/A cmd N/A git remote add %s %s N/A name remote_url N/A N/A cd path N/A N/A N/A use_sudo N/A user None N/A N/A N/A run_as_root cmd N/A N/A use_sudo N/A N/A N/A sudo cmd user user N/A N/A N/A run cmd N/A fetch N/A N/A path use_sudo user remote N/A False None None N/A N/A 
    Fetch changes from the default remote repository.

    This will fetch new changesets, but will not update the contents of
    the working tree unless yo do a merge or rebase.

    :param path: Path of the working copy directory.  This directory must exist
                 and be a Git working copy with a default remote to fetch from.
    :type path: str

    :param use_sudo: If ``True`` execute ``git`` with
                     :func:`fabric.operations.sudo`, else with
                     :func:`fabric.operations.run`.
    :type use_sudo: bool

    :param user: If ``use_sudo is True``, run :func:`fabric.operations.sudo`
                 with the given user.  If ``use_sudo is False`` this parameter
                 has no effect.
    :type user: str

    :type remote: Fetch this remote or default remote if is None
    :type remote: str
     N/A N/A path None N/A N/A N/A ValueError Path to the working copy is needed to fetch from a remote repository. N/A N/A remote None N/A N/A cmd N/A git fetch %s remote N/A N/A cmd git fetch N/A N/A cd path N/A N/A N/A use_sudo N/A user None N/A N/A N/A run_as_root cmd N/A N/A use_sudo N/A N/A N/A sudo cmd user user N/A N/A N/A run cmd N/A pull N/A N/A path use_sudo user force N/A False None False N/A N/A 
    Fetch changes from the default remote repository and merge them.

    :param path: Path of the working copy directory.  This directory must exist
                 and be a Git working copy with a default remote to pull from.
    :type path: str

    :param use_sudo: If ``True`` execute ``git`` with
                     :func:`fabric.operations.sudo`, else with
                     :func:`fabric.operations.run`.
    :type use_sudo: bool

    :param user: If ``use_sudo is True``, run :func:`fabric.operations.sudo`
                 with the given user.  If ``use_sudo is False`` this parameter
                 has no effect.
    :type user: str
    :param force: If ``True``, append the ``--force`` option to the command.
    :type force: bool
     N/A N/A path None N/A N/A N/A ValueError Path to the working copy is needed to pull from a remote repository. N/A options N/A N/A force N/A N/A N/A N/A options append --force N/A options N/A N/A join options N/A cmd N/A git pull %s options N/A N/A cd path N/A N/A N/A use_sudo N/A user None N/A N/A N/A run_as_root cmd N/A N/A use_sudo N/A N/A N/A sudo cmd user user N/A N/A N/A run cmd N/A checkout N/A N/A path branch use_sudo user force N/A master False None False N/A N/A 
    Checkout a branch to the working directory.

    :param path: Path of the working copy directory.  This directory must exist
                 and be a Git working copy.
    :type path: str

    :param branch: Name of the branch to checkout.
    :type branch: str

    :param use_sudo: If ``True`` execute ``git`` with
                     :func:`fabric.operations.sudo`, else with
                     :func:`fabric.operations.run`.
    :type use_sudo: bool

    :param user: If ``use_sudo is True``, run :func:`fabric.operations.sudo`
                 with the given user.  If ``use_sudo is False`` this parameter
                 has no effect.
    :type user: str
    :param force: If ``True``, append the ``--force`` option to the command.
    :type force: bool
     N/A N/A path None N/A N/A N/A ValueError Path to the working copy is needed to checkout a branch N/A options N/A N/A force N/A N/A N/A N/A options append --force N/A options N/A N/A join options N/A cmd N/A git checkout %s %s N/A branch options N/A N/A cd path N/A N/A N/A use_sudo N/A user None N/A N/A N/A run_as_root cmd N/A N/A use_sudo N/A N/A N/A sudo cmd user user N/A N/A N/A run cmd N/A