str(object='') -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

bool(x) -> bool

Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

Sets Cuisine into local mode, where run/sudo won't go through Fabric's API, but directly through a popen. This allows you to easily test your Cuisine scripts without using Fabric.

bool(x) -> bool

Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

Comes back to Fabric's API for run/sudo. This basically reverts the effect of calling mode_local().

str(object='') -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

Cuisine functions will be executed with sudo.

Cuisine functions will be executed as the current user.

Tests if the given command is available on the system.

Ensures that the given command is present, if not installs the package with the given name, which is the same as the command by default.

Sets Fabric's current host to the given host. This is useful when using Cuisine in standalone.

Updates the mode/owner/group for the given remote directory.

Ensures that there is a remote directory at the given location, optionally updating its mode/owner/group.

If we are not updating the owner/group then this can be done as a single ssh call, so use that method, otherwise set owner/group after creation.

Tells if there is a remote directory at the given location.

Removes a directory

Dispatches the current function to specific implementation. The prefix parameter indicates the common option prefix, and the select_[option]() function will determine the function suffix.

For instance the package functions are defined like this:

{{{ @dispatch("package") def packageensure(...): ... def packageensureapt(...): ... def packageensure_yum(…): … }}}

and then when a user does

{{{ cuisine.selectpackage("yum") cuisine.packageensure(…) }}}

then the dispatch function will dispatch package_ensure to package_ensure_yum.

If your prefix is the first word of the function name before the first _ then you can simply use @dispatch without parameters.

Appends the given content to the remote file at the given location, optionally updating its mode/owner/group.

Updates the mode/owner/group for the remote file at the given location.

Return mode, owner, and group for remote path. Return mode, owner, and group if remote path exists, None otherwise.

Updates the mode/owner/group for the remote file at the given location.

Tests if there is a remote file at the given location.

Creates a (symbolic) link between source and destination on the remote host, optionally setting its mode/owner/group.

Reads a local file from the given location, expanding ~ and shell variables.

Returns the MD5 sum (as a hex string) for the remote file at the given location.

Reads the remote file at the given location.

Returns the SHA-256 sum (as a hex string) for the remote file at the given location.

Updates the content of the given by passing the existing content of the remote file at the given location to the updater function.

For instance, if you'd like to convert an existing file to all uppercase, simply do:

file_update("/etc/myfile", lambda _:_.upper())

Uploads the local file to the remote location only if the remote location does not exists or the content are different.

Writes the given content to the file at the given remote location, optionally setting mode/owner/group.

Checks if there is a group defined with the given name, returning its information as a {"name":<str>,"gid":<str>,"members":<list[str]>} or None if the group does not exists.

Creates a group with the given name, and optionally given gid.

Ensures that the group with the given name (and optional gid) exists.

Adds the given user/list of users to the given group/groups.

Checks if the given user is a member of the given group. It will return False if the group does not exist.

remove the given user from the given group.

Ensure that a given user is a member of a given group.

Queries the given Cuisine mode (ie. MODELOCAL, MODESUDO)

Clean the repository for un-needed files.

Tests if the given package is installed, and installs it in case it's not already there. If update is true, then the package will be updated if it already exists.

Ensure apt packages are installed

Ensure apt packages are installed

Installs the given package/list of package, optionally updating the package database.

Remove package and optionally clean unused packages

Updates the package database (when no argument) or update the package or list of packages given as argument.

Updates every package present on the system.

Returns the pids of processes with the given name. If exact is False it will return the list of all processes that start with the given name.

Kills the given processes with the given name. If exact is False it will return the list of all processes that start with the given name.

Tests if the given python package is installed, and installes it in case it's not already there.

The "package" argument, defines the name of the package that will be ensured.

The "package" argument, defines the name of the package that will be ensured. The argument "r" referes to the requirements file that will be used by pip and is equivalent to the "-r" parameter of pip. Either "package" or "r" needs to be provided The optional argument "E" is equivalent to the "-E" parameter of pip. E is the path to a virtualenv. If provided, it will be added to the pip call.

Installs the given python package/list of python packages.

The "package" argument, defines the name of the package that will be installed.

The "package" argument, defines the name of the package that will be installed. The argument "r" referes to the requirements file that will be used by pip and is equivalent to the "-r" parameter of pip. Either "package" or "r" needs to be provided The optional argument "E" is equivalent to the "-E" parameter of pip. E is the path to a virtualenv. If provided, it will be added to the pip call.

Removes the given python package.

The "package" argument, defines the name of the package that will be removed.

The "package" argument, defines the name of the package that will be ensured. The argument "r" referes to the requirements file that will be used by pip and is equivalent to the "-r" parameter of pip. Either "package" or "r" needs to be provided The optional argument "E" is equivalent to the "-E" parameter of pip. E is the path to a virtualenv. If provided, it will be added to the pip call.

Upgrades the defined python package.

The "package" argument, defines the name of the package that will be upgraded.

The "package" argument, defines the name of the package that will be upgraded. The optional argument "E" is equivalent to the "-E" parameter of pip. E is the path to a virtualenv. If provided, it will be added to the pip call.

A wrapper to Fabric's run/sudo commands that takes into account the MODE_LOCAL and MODE_SUDO modes of Cuisine.

Local implementation of fabric.api.run() using subprocess.

Note: pty option exists for function signature compatibility and is ignored.

Selects the type of package subsystem to use (ex:apt, yum, zypper, pacman, or emerge).

Adds the given key to the .ssh/authorized_keys for the given user.

Generates a pair of ssh keys in the user's home .ssh directory.

Removes the given key to the .ssh/authorized_keys for the given user.

A wrapper to Fabric's run/sudo commands, using the 'cuisine.MODE_SUDO' global to tell whether the command should be run as regular user or sudo.

Sets the password for the sudo command.

Gets a machines UUID (Universally Unique Identifier).

Adds system UUID alias to /etc/hosts. Some tools/processes rely/want the hostname as an alias in /etc/hosts e.g. 127.0.0.1 localhost <hostname>.

Ensures that the given lines are present in the given text, otherwise appends the lines that are not already in the text at the end of it.

Returns the first line that matches the given predicate.

Converts tabs and spaces to single space and strips the text.

Converts tabs and spaces to single space and strips the text.

Replaces lines equal to old with new, returning the new text and the count of replacements.

Substitutes ${PLACEHOLDER}s within the text with the corresponding values from variables.

Ensures that the given upstart service is running, restarting it if necessary.

Checks if there is a user defined with the given name, returning its information as a {"name":<str>,"uid":<str>,"gid":<str>,"home":<str>,"shell":<str>} or None if the user does not exists. need_passwd (Boolean) indicates if password to be included in result or not. If set to True it parses getent shadow and needs sudo access

Creates the user with the given name, optionally giving a specific password/home/uid/gid/shell.

Ensures that the given users exists, optionally updating their passwd/home/uid/gid/shell.

Sets the given user password. Password is expected to be encrypted by default.

Removes the user with the given name, optionally removing the home directory and mail spool.

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

str(object='') -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

str(object='') -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

str(object='') -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

Compiled regular expression objects

str(object='') -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

str(object='') -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

str(object='') -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

cuisine makes it easy to write automatic server installation and configuration recipes by wrapping common administrative tasks (installing packages, creating users and groups) in Python functions.

cuisine is designed to work with Fabric and provide all you need for getting your new server up and running in minutes.

Note, that right now, Cuisine only supports Debian-based Linux systems.

See also:

• Deploying Django with Fabric http://lethain.com/entry/2008/nov/04/deploying-django-with-fabric

• Notes on Python Fabric 0.9b1 http://www.saltycrane.com/blog/2009/10/notes-python-fabric-09b1`_

• EC2, fabric, and "err: stdin: is not a tty" http://blog.markfeeney.com/2009/12/ec2-fabric-and-err-stdin-is-not-tty.html`_

:copyright: (c) 2011-2013 by Sébastien Pierre. :license: BSD, see LICENSE for more details.

Updates the content of the given by passing the existing content of the remote file at the given location to the updater function.

For instance, if you'd like to convert an existing file to all uppercase, simply do:

file_update("/etc/myfile", lambda _:_.upper())

The "package" argument, defines the name of the package that will be upgraded.

Ensures that the given upstart service is running, restarting it if necessary.

Local implementation of fabric.api.run() using subprocess.

Note: pty option exists for function signature compatibility and is ignored.

Kills the given processes with the given name. If exact is False it will return the list of all processes that start with the given name.

Remove package and optionally clean unused packages

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Gets a machines UUID (Universally Unique Identifier).

The "package" argument, defines the name of the package that will be removed.

Ensures that the group with the given name (and optional gid) exists.

Adds the given user/list of users to the given group/groups.

Checks if there is a group defined with the given name, returning its information as a {"name":<str>,"gid":<str>,"members":<list[str]>} or None if the group does not exists.

Creates a group with the given name, and optionally given gid.

Ensure that a given user is a member of a given group.

Checks if the given user is a member of the given group. It will return False if the group does not exist.

remove the given user from the given group.

Reads the remote file at the given location.

Returns the SHA-256 sum (as a hex string) for the remote file at the given location.

Reads a local file from the given location, expanding ~ and shell variables.

Returns the MD5 sum (as a hex string) for the remote file at the given location.

Uploads the local file to the remote location only if the remote location does not exists or the content are different.

Writes the given content to the file at the given remote location, optionally setting mode/owner/group.

Queries the given Cuisine mode (ie. MODELOCAL, MODESUDO)

Updates the mode/owner/group for the remote file at the given location.

Tests if there is a remote file at the given location.

Return mode, owner, and group for remote path. Return mode, owner, and group if remote path exists, None otherwise.

Creates a (symbolic) link between source and destination on the remote host, optionally setting its mode/owner/group.

Updates the mode/owner/group for the remote file at the given location.

Dispatches the current function to specific implementation. The prefix parameter indicates the common option prefix, and the select_[option]() function will determine the function suffix.

For instance the package functions are defined like this:

{{{ @dispatch("package") def packageensure(...): ... def packageensureapt(...): ... def packageensure_yum(…): … }}}

and then when a user does

{{{ cuisine.selectpackage("yum") cuisine.packageensure(…) }}}

then the dispatch function will dispatch package_ensure to package_ensure_yum.

If your prefix is the first word of the function name before the first _ then you can simply use @dispatch without parameters.

Appends the given content to the remote file at the given location, optionally updating its mode/owner/group.

Converts tabs and spaces to single space and strips the text.

Ensures that the given command is present, if not installs the package with the given name, which is the same as the command by default.

Sets Fabric's current host to the given host. This is useful when using Cuisine in standalone.

Tests if the given command is available on the system.

Tells if there is a remote directory at the given location.

Removes a directory

Updates the mode/owner/group for the given remote directory.

Ensures that there is a remote directory at the given location, optionally updating its mode/owner/group.

If we are not updating the owner/group then this can be done as a single ssh call, so use that method, otherwise set owner/group after creation.

bool(x) -> bool

Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

Cuisine functions will be executed with sudo.

Updates every package present on the system.

Cuisine functions will be executed as the current user.

str(object='') -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

Sets Cuisine into local mode, where run/sudo won't go through Fabric's API, but directly through a popen. This allows you to easily test your Cuisine scripts without using Fabric.

cuisine makes it easy to write automatic server installation and configuration recipes by wrapping common administrative tasks (installing packages, creating users and groups) in Python functions.

cuisine is designed to work with Fabric and provide all you need for getting your new server up and running in minutes.

Note, that right now, Cuisine only supports Debian-based Linux systems.

See also:

• Deploying Django with Fabric http://lethain.com/entry/2008/nov/04/deploying-django-with-fabric

• Notes on Python Fabric 0.9b1 http://www.saltycrane.com/blog/2009/10/notes-python-fabric-09b1`_

• EC2, fabric, and "err: stdin: is not a tty" http://blog.markfeeney.com/2009/12/ec2-fabric-and-err-stdin-is-not-tty.html`_

:copyright: (c) 2011-2013 by Sébastien Pierre. :license: BSD, see LICENSE for more details.

str(object='') -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

Ensure apt packages are installed

Installs the given package/list of package, optionally updating the package database.

str(object='') -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

Sets the given user password. Password is expected to be encrypted by default.

The "package" argument, defines the name of the package that will be ensured.

Comes back to Fabric's API for run/sudo. This basically reverts the effect of calling mode_local().

str(object='') -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

str(object='') -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

The "package" argument, defines the name of the package that will be installed.

Upgrades the defined python package.

A wrapper to Fabric's run/sudo commands that takes into account the MODE_LOCAL and MODE_SUDO modes of Cuisine.

Replaces lines equal to old with new, returning the new text and the count of replacements.

The "package" argument, defines the name of the package that will be ensured. The argument "r" referes to the requirements file that will be used by pip and is equivalent to the "-r" parameter of pip. Either "package" or "r" needs to be provided The optional argument "E" is equivalent to the "-E" parameter of pip. E is the path to a virtualenv. If provided, it will be added to the pip call.

Removes the given key to the .ssh/authorized_keys for the given user.

Sets the password for the sudo command.

Ensure apt packages are installed

bool(x) -> bool

Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

str(object='') -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

Checks if there is a user defined with the given name, returning its information as a {"name":<str>,"uid":<str>,"gid":<str>,"home":<str>,"shell":<str>} or None if the user does not exists. need_passwd (Boolean) indicates if password to be included in result or not. If set to True it parses getent shadow and needs sudo access

Returns the pids of processes with the given name. If exact is False it will return the list of all processes that start with the given name.

str(object='') -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

Ensures that the given lines are present in the given text, otherwise appends the lines that are not already in the text at the end of it.

Tests if the given package is installed, and installs it in case it's not already there. If update is true, then the package will be updated if it already exists.

Removes the given python package.

Adds system UUID alias to /etc/hosts. Some tools/processes rely/want the hostname as an alias in /etc/hosts e.g. 127.0.0.1 localhost <hostname>.

Updates the package database (when no argument) or update the package or list of packages given as argument.

Creates the user with the given name, optionally giving a specific password/home/uid/gid/shell.

Generates a pair of ssh keys in the user's home .ssh directory.

Compiled regular expression objects

Selects the type of package subsystem to use (ex:apt, yum, zypper, pacman, or emerge).

Returns the first line that matches the given predicate.

The "package" argument, defines the name of the package that will be upgraded. The optional argument "E" is equivalent to the "-E" parameter of pip. E is the path to a virtualenv. If provided, it will be added to the pip call.

Substitutes ${PLACEHOLDER}s within the text with the corresponding values from variables.

Installs the given python package/list of python packages.

The "package" argument, defines the name of the package that will be ensured. The argument "r" referes to the requirements file that will be used by pip and is equivalent to the "-r" parameter of pip. Either "package" or "r" needs to be provided The optional argument "E" is equivalent to the "-E" parameter of pip. E is the path to a virtualenv. If provided, it will be added to the pip call.

Clean the repository for un-needed files.

Ensures that the given users exists, optionally updating their passwd/home/uid/gid/shell.

Tests if the given python package is installed, and installes it in case it's not already there.

A wrapper to Fabric's run/sudo commands, using the 'cuisine.MODE_SUDO' global to tell whether the command should be run as regular user or sudo.

Removes the user with the given name, optionally removing the home directory and mail spool.

The "package" argument, defines the name of the package that will be installed. The argument "r" referes to the requirements file that will be used by pip and is equivalent to the "-r" parameter of pip. Either "package" or "r" needs to be provided The optional argument "E" is equivalent to the "-E" parameter of pip. E is the path to a virtualenv. If provided, it will be added to the pip call.

Converts tabs and spaces to single space and strips the text.

str(object='') -> string

Return a nice string representation of the object. If the argument is a string, the return value is the same object.

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Adds the given key to the .ssh/authorized_keys for the given user.