pylorax.api package

Submodules

pylorax.api.bisect module

pylorax.api.bisect.insort_left(a, x, key=None, lo=0, hi=None)

Insert item x in list a, and keep it sorted assuming a is sorted.

Parameters:

• a (list) -- sorted list
• x (object) -- item to insert into the list
• key (function) -- Function to use to compare items in the list

Returns:

index where the item was inserted

Return type:

int

If x is already in a, insert it to the left of the leftmost x. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

This is a modified version of bisect.insort_left that can use a function for the compare, and returns the index position where it was inserted.

pylorax.api.checkparams module

pylorax.api.checkparams.checkparams(tuples)

pylorax.api.cmdline module

pylorax.api.cmdline.lorax_composer_parser()

Return the ArgumentParser for lorax-composer

pylorax.api.compose module

Setup for composing an image

Adding New Output Types

The new output type must add a kickstart template to ./share/composer/ where the name of the kickstart (without the trailing .ks) matches the entry in compose_args.

The kickstart should not have any url or repo entries, these will be added at build time. The %packages section should be the last thing, and while it can contain mandatory packages required by the output type, it should not have the trailing %end because the package NEVRAs will be appended to it at build time.

compose_args should have a name matching the kickstart, and it should set the novirt_install parameters needed to generate the desired output. Other types should be set to False.

pylorax.api.compose.add_customizations(f, recipe)

Add customizations to the kickstart file

Parameters:

• f (open file object) -- kickstart file object
• recipe (Recipe object) --

Returns:

None

Raises:

RuntimeError if there was a problem writing to the kickstart

pylorax.api.compose.bootloader_append(line, kernel_append)

Insert the kernel_append string into the --append argument

Parameters:

• line (str) -- The bootloader ... line
• kernel_append (str) -- The arguments to append to the --append section

Using pykickstart to process the line is the best way to make sure it is parsed correctly, and re-assembled for inclusion into the final kickstart

pylorax.api.compose.compose_args(compose_type)

Returns the settings to pass to novirt_install for the compose type

Parameters:compose_type (str) -- The type of compose to create, from compose_types()

This will return a dict of options that match the ArgumentParser options for livemedia-creator. These are the ones the define the type of output, it's filename, etc. Other options will be filled in by make_compose()

pylorax.api.compose.compose_types(share_dir)

Returns a list of the supported output types

The output types come from the kickstart names in /usr/share/lorax/composer/*ks

pylorax.api.compose.customize_ks_template(ks_template, recipe)

Customize the kickstart template and return it

Parameters:

• ks_template (str) -- The kickstart template
• recipe (Recipe object) --

Apply customizations to existing template commands, or add defaults for ones that are missing and required.

Apply customizations.kernel.append to the bootloader argument in the template. Add bootloader line if it is missing.

Add default timezone if needed. It does NOT replace an existing timezone entry

pylorax.api.compose.firewall_cmd(line, settings)

Update the firewall line with the new ports and services

Parameters:

• line (str) -- The firewall ... line
• settings (dict) -- A dict with the list of services and ports to enable and disable

Using pykickstart to process the line is the best way to make sure it is parsed correctly, and re-assembled for inclusion into the final kickstart

pylorax.api.compose.get_default_services(recipe)

Get the default string for services, based on recipe :param recipe: The recipe

Returns:string with "services" or "" Return type:str

When no services have been selected we don't need to add anything to the kickstart so return an empty string. Otherwise return "services" which will be updated with the settings.

pylorax.api.compose.get_extra_pkgs(dbo, share_dir, compose_type)

Return extra packages needed for the output type

Parameters:

• dbo (dnf.Base) -- dnf base object
• share_dir (str) -- Path to the top level share directory
• compose_type (str) -- The type of output to create from the recipe

Returns:

List of package names (name only, not NEVRA)

Return type:

list

Currently this is only needed by live-iso, it reads ./live/live-install.tmpl and processes only the installpkg lines. It lists the packages needed to complete creation of the iso using the templates such as x86.tmpl

Keep in mind that the live-install.tmpl is shared between livemedia-creator and lorax-composer, even though the results are applied differently.

pylorax.api.compose.get_firewall_settings(recipe)

Return the customizations.firewall settings

Parameters:recipe (Recipe object) -- The recipe Returns:A dict of settings Return type:dict

pylorax.api.compose.get_kernel_append(recipe)

Return the customizations.kernel append value

Parameters:recipe (Recipe object) -- Returns:append value or empty string Return type:str

pylorax.api.compose.get_keyboard_layout(recipe)

Return the customizations.locale.keyboard list

Parameters:recipe (Recipe object) -- The recipe Returns:The keyboard layout string Return type:str

pylorax.api.compose.get_languages(recipe)

Return the customizations.locale.languages list

Parameters:recipe (Recipe object) -- The recipe Returns:list of language strings Return type:list

pylorax.api.compose.get_services(recipe)

Return the customizations.services settings

Parameters:recipe (Recipe object) -- The recipe Returns:A dict of settings Return type:dict

pylorax.api.compose.get_timezone_settings(recipe)

Return the customizations.timezone dict

Parameters:recipe (Recipe object) -- Returns:append value or empty string Return type:dict

pylorax.api.compose.keyboard_cmd(line, layout)

Update the keyboard line with the layout

Parameters:

• line (str) -- The keyboard ... line
• settings (str) -- The keyboard layout

Using pykickstart to process the line is the best way to make sure it is parsed correctly, and re-assembled for inclusion into the final kickstart

pylorax.api.compose.lang_cmd(line, languages)

Update the lang line with the languages

Parameters:

• line (str) -- The lang ... line
• settings (list) -- The list of languages

Using pykickstart to process the line is the best way to make sure it is parsed correctly, and re-assembled for inclusion into the final kickstart

pylorax.api.compose.move_compose_results(cfg, results_dir)

Move the final image to the results_dir and cleanup the unneeded compose files

Parameters:

• cfg (DataHolder) -- Build configuration
• results_dir (str) -- Directory to put the results into

pylorax.api.compose.repo_to_ks(r, url='url')

Return a kickstart line with the correct args. :param r: DNF repository information :type r: dnf.Repo :param url: "url" or "baseurl" to use for the baseurl parameter :type url: str :returns: kickstart command arguments for url/repo command :rtype: str

Set url to "baseurl" if it is a repo, leave it as "url" for the installation url.

pylorax.api.compose.services_cmd(line, settings)

Update the services line with additional services to enable/disable

Parameters:

• line (str) -- The services ... line
• settings (dict) -- A dict with the list of services to enable and disable

Using pykickstart to process the line is the best way to make sure it is parsed correctly, and re-assembled for inclusion into the final kickstart

pylorax.api.compose.start_build(cfg, dnflock, gitlock, branch, recipe_name, compose_type, test_mode=0)

Start the build

Parameters:

• cfg (ComposerConfig) -- Configuration object
• dnflock (YumLock) -- Lock and YumBase for depsolving
• recipe (str) -- The recipe to build
• compose_type (str) -- The type of output to create from the recipe

Returns:

Unique ID for the build that can be used to track its status

Return type:

str

pylorax.api.compose.test_templates(dbo, share_dir)

Try depsolving each of the the templates and report any errors

Parameters:dbo (dnf.Base) -- dnf base object Returns:List of template types and errors Return type:List of errors

Return a list of templates and errors encountered or an empty list

pylorax.api.compose.timezone_cmd(line, settings)

Update the timezone line with the settings

Parameters:

• line (str) -- The timezone ... line
• settings (dict) -- A dict with timezone and/or ntpservers list

Using pykickstart to process the line is the best way to make sure it is parsed correctly, and re-assembled for inclusion into the final kickstart

pylorax.api.compose.write_ks_group(f, group)

Write kickstart group entry

Parameters:

• f (open file object) -- kickstart file object
• group -- A blueprint group dictionary

gid is optional

pylorax.api.compose.write_ks_root(f, user)

Write kickstart root password and sshkey entry

Parameters:

• f (open file object) -- kickstart file object
• user (dict) -- A blueprint user dictionary

Returns:

True if it wrote a rootpw command to the kickstart

Return type:

bool

If the entry contains a ssh key, use sshkey to write it If it contains password, use rootpw to set it

root cannot be used with the user command. So only key and password are supported for root.

pylorax.api.compose.write_ks_user(f, user)

Write kickstart user and sshkey entry

Parameters:

• f (open file object) -- kickstart file object
• user (dict) -- A blueprint user dictionary

If the entry contains a ssh key, use sshkey to write it All of the user fields are optional, except name, write out a kickstart user entry with whatever options are relevant.

pylorax.api.config module

class pylorax.api.config.ComposerConfig(defaults=None, dict_type=<class 'collections.OrderedDict'>, allow_no_value=False, *, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section='DEFAULT', interpolation=<object object>, converters=<object object>)

Bases: configparser.ConfigParser

get_default(section, option, default)

pylorax.api.config.configure(conf_file='/etc/lorax/composer.conf', root_dir='/', test_config=False)

lorax-composer configuration

Parameters:

• conf_file (str) -- Path to the config file overriding the default settings
• root_dir (str) -- Directory to prepend to paths, defaults to /
• test_config (bool) -- Set to True to skip reading conf_file

pylorax.api.config.make_dnf_dirs(conf, uid, gid)

Make any missing dnf directories owned by user:group

Parameters:

• conf (ComposerConfig) -- The configuration to use
• uid (int) -- uid of owner
• gid (int) -- gid of owner

Returns:

list of errors

Return type:

list of str

pylorax.api.config.make_owned_dir(p_dir, uid, gid)

Make a directory and its parents, setting owner and group

Parameters:

• p_dir (string) -- path to directory to create
• uid (int) -- uid of owner
• gid (int) -- gid of owner

Returns:

list of errors

Return type:

list of str

Check to make sure it does not have o+rw permissions and that it is owned by uid:gid

pylorax.api.config.make_queue_dirs(conf, gid)

Make any missing queue directories

Parameters:

• conf (ComposerConfig) -- The configuration to use
• gid (int) -- Group ID that has access to the queue directories

Returns:

list of errors

Return type:

list of str

pylorax.api.crossdomain module

pylorax.api.crossdomain.crossdomain(origin, methods=None, headers=None, max_age=21600, attach_to_all=True, automatic_options=True)

pylorax.api.dnfbase module

class pylorax.api.dnfbase.DNFLock(conf, expire_secs=21600)

Bases: object

Hold the dnf.Base object and a Lock to control access to it.

self.dbo is a property that returns the dnf.Base object, but it may change from one call to the next if the upstream repositories have changed.

lock

Check for repo updates (using expiration time) and return the lock

If the repository has been updated, tear down the old dnf.Base and create a new one. This is the only way to force dnf to use the new metadata.

lock_check

Force a check for repo updates and return the lock

Use this method sparingly, it removes the repodata and downloads a new copy every time.

pylorax.api.dnfbase.get_base_object(conf)

Get the DNF object with settings from the config file

Parameters:conf (ComposerParser) -- configuration object Returns:A DNF Base object Return type:dnf.Base

pylorax.api.errors module

pylorax.api.gitrpm module

Clone a git repository and package it as an rpm

This module contains functions for cloning a git repo, creating a tar archive of the selected commit, branch, or tag, and packaging the files into an rpm that will be installed by anaconda when creating the image.

class pylorax.api.gitrpm.GitArchiveTarball(gitRepo)

Bases: object

Create a git archive of the selected git repo and reference

write_file(sourcesDir)

Create the tar archive

Parameters:sourcesDir (str) -- Path to use for creating the archive

This clones the git repository and creates a git archive from the specified reference. The result is in RPMNAME.tar.xz under the sourcesDir

class pylorax.api.gitrpm.GitRpmBuild(*args, **kwargs)

Bases: rpmfluff.SimpleRpmBuild

Build an rpm containing files from a git repository

add_git_tarball(gitRepo)

Add a tar archive of a git repository to the rpm

Parameters:gitRepo (dict) -- A dict with the repository details

This populates the rpm with the URL of the git repository, the summary describing the repo, the description of the repository and reference used, and sets up the rpm to install the archive contents into the destination path.

check()

clean()

Remove the base directory from inside the tmpdir

cleanup_tmpdir()

Remove the temporary directory and all of its contents

get_base_dir()

Place all the files under a temporary directory + rpmbuild/

pylorax.api.gitrpm.create_gitrpm_repo(results_dir, recipe)

Create a dnf repository with the rpms from the recipe

Parameters:

• results_dir (str) -- Path to create the repository under
• recipe (Recipe) -- The recipe to get the repos.git entries from

Returns:

Path to the dnf repository or ""

Return type:

str

This function creates a dnf repository directory at results_dir+"repo/", creates rpms for all of the repos.git entries in the recipe, runs createrepo_c on the dnf repository so that Anaconda can use it, and returns the path to the repository to the caller.

pylorax.api.gitrpm.get_repo_description(gitRepo)

Return a description including the git repo and reference

Parameters:gitRepo (dict) -- A dict with the repository details Returns:A string with the git repo url and reference Return type:str

pylorax.api.gitrpm.make_git_rpm(gitRepo, dest)

Create an rpm from the specified git repo

Parameters:gitRepo (dict) -- A dict with the repository details

This will clone the git repository, create an archive of the selected reference, and build an rpm that will install the files from the repository under the destination directory. The gitRepo dict should have the following fields:

rpmname: "server-config"
rpmversion: "1.0"
rpmrelease: "1"
summary: "Setup files for server deployment"
repo: "PATH OF GIT REPO TO CLONE"
ref: "v1.0"
destination: "/opt/server/"

• rpmname: Name of the rpm to create, also used as the prefix name in the tar archive
• rpmversion: Version of the rpm, eg. "1.0.0"
• rpmrelease: Release of the rpm, eg. "1"
• summary: Summary string for the rpm
• repo: URL of the get repo to clone and create the archive from
• ref: Git reference to check out. eg. origin/branch-name, git tag, or git commit hash
• destination: Path to install the / of the git repo at when installing the rpm

pylorax.api.projects module

exception pylorax.api.projects.ProjectsError

Bases: Exception

pylorax.api.projects.api_changelog(changelog)

Convert the changelog to a string

Parameters:changelog (tuple) -- A list of time, author, string tuples. Returns:The most recent changelog text or "" Return type:str

This returns only the most recent changelog entry.

pylorax.api.projects.api_time(t)

Convert time since epoch to a string

Parameters:t (int) -- Seconds since epoch Returns:Time string Return type:str

pylorax.api.projects.delete_repo_source(source_glob, source_name)

Delete a source from a repo file

Parameters:source_glob (str) -- A glob of the repo sources to search Returns:None Raises:ProjectsError if there was a problem

A repo file may have multiple sources in it, delete only the selected source. If it is the last one in the file, delete the file.

WARNING: This will delete ANY source, the caller needs to ensure that a system source_name isn't passed to it.

pylorax.api.projects.dep_evra(dep)

Return the epoch:version-release.arch for the dep

Parameters:dep (dict) -- dependency dict Returns:epoch:version-release.arch Return type:str

pylorax.api.projects.dep_nevra(dep)

Return the name-epoch:version-release.arch

pylorax.api.projects.dnf_repo_to_file_repo(repo)

Return a string representation of a DNF Repo object suitable for writing to a .repo file

Parameters:repo (dnf.RepoDict) -- DNF Repository Returns:A string Return type:str

The DNF Repo.dump() function does not produce a string that can be used as a dnf .repo file, it ouputs baseurl and gpgkey as python lists which DNF cannot read. So do this manually with only the attributes we care about.

pylorax.api.projects.estimate_size(packages, block_size=6144)

Estimate the installed size of a package list

Parameters:

• packages (list of hawkey.Package objects) -- The packages to be installed
• block_size (int) -- The block size to use for rounding up file sizes.

Returns:

The estimated size of installed packages

Return type:

int

Estimating actual requirements is difficult without the actual file sizes, which dnf doesn't provide access to. So use the file count and block size to estimate a minimum size for each package.

pylorax.api.projects.get_repo_sources(source_glob)

Return a list of sources from a directory of yum repositories

Parameters:source_glob (str) -- A glob to use to match the source files, including full path Returns:A list of the source ids in all of the matching files Return type:list of str

pylorax.api.projects.get_source_ids(source_path)

Return a list of the source ids in a file

Parameters:source_path (str) -- Full path and filename of the source (yum repo) file Returns:A list of source id strings Return type:list of str

pylorax.api.projects.modules_info(dbo, module_names)

Return details about a module, including dependencies

Parameters:

• dbo (dnf.Base) -- dnf base object
• module_names (str) -- Names of the modules to get info about

Returns:

List of dicts with module details and dependencies.

Return type:

list of dicts

pylorax.api.projects.modules_list(dbo, module_names)

Return a list of modules

Parameters:

• dbo (dnf.Base) -- dnf base object
• offset -- Number of modules to skip
• limit (int) -- Maximum number of modules to return

Returns:

List of module information and total count

Return type:

tuple of a list of dicts and an Int

Modules don't exist in RHEL7 so this only returns projects and sets the type to "rpm"

pylorax.api.projects.pkg_to_build(pkg)

Extract the build details from a hawkey.Package object

Parameters:pkg (hawkey.Package) -- hawkey.Package object with package details Returns:A dict with the build details, epoch, release, arch, build_time, changelog, ... Return type:dict

metadata entries are hard-coded to {}

Note that this only returns the build dict, it does not include the name, description, etc.

pylorax.api.projects.pkg_to_dep(pkg)

Extract the info from a hawkey.Package object

Parameters:pkg (hawkey.Package) -- A hawkey.Package object Returns:A dict with name, epoch, version, release, arch Return type:dict

pylorax.api.projects.pkg_to_project(pkg)

Extract the details from a hawkey.Package object

Parameters:pkgs (hawkey.Package) -- hawkey.Package object with package details Returns:A dict with the name, summary, description, and url. Return type:dict

upstream_vcs is hard-coded to UPSTREAM_VCS

pylorax.api.projects.pkg_to_project_info(pkg)

Extract the details from a hawkey.Package object

Parameters:pkg (hawkey.Package) -- hawkey.Package object with package details Returns:A dict with the project details, as well as epoch, release, arch, build_time, changelog, ... Return type:dict

metadata entries are hard-coded to {}

pylorax.api.projects.proj_to_module(proj)

Extract the name from a project_info dict

Parameters:pkg (dict) -- dict with package details Returns:A dict with name, and group_type Return type:dict

group_type is hard-coded to "rpm"

pylorax.api.projects.projects_depsolve(dbo, projects, groups)

Return the dependencies for a list of projects

Parameters:

• dbo (dnf.Base) -- dnf base object
• projects (List of Strings) -- The projects to find the dependencies for
• groups (List of str) -- The groups to include in dependency solving

Returns:

NEVRA's of the project and its dependencies

Return type:

list of dicts

Raises:

ProjectsError if there was a problem installing something

pylorax.api.projects.projects_depsolve_with_size(dbo, projects, groups, with_core=True)

Return the dependencies and installed size for a list of projects

Parameters:

• dbo (dnf.Base) -- dnf base object
• project_names (List of Strings) -- The projects to find the dependencies for
• groups (List of str) -- The groups to include in dependency solving

Returns:

installed size and a list of NEVRA's of the project and its dependencies

Return type:

tuple of (int, list of dicts)

Raises:

ProjectsError if there was a problem installing something

pylorax.api.projects.projects_info(dbo, project_names)

Return details about specific projects

Parameters:

• dbo (dnf.Base) -- dnf base object
• project_names (str) -- List of names of projects to get info about

Returns:

List of project info dicts with pkg_to_project as well as epoch, version, release, etc.

Return type:

list of dicts

If project_names is None it will return the full list of available packages

pylorax.api.projects.projects_list(dbo)

Return a list of projects

Parameters:dbo (dnf.Base) -- dnf base object Returns:List of project info dicts with name, summary, description, homepage, upstream_vcs Return type:list of dicts

pylorax.api.projects.repo_to_source(repo, system_source)

Return a Weldr Source dict created from the DNF Repository

Parameters:

• repo (dnf.RepoDict) -- DNF Repository
• system_source (bool) -- True if this source is an immutable system source

Returns:

A dict with Weldr Source fields filled in

Return type:

dict

Example:

{
  "check_gpg": true,
  "check_ssl": true,
  "gpgkey_url": [
    "file:///etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-28-x86_64"
  ],
  "name": "fedora",
  "proxy": "http://proxy.brianlane.com:8123",
  "system": true
  "type": "yum-metalink",
  "url": "https://mirrors.fedoraproject.org/metalink?repo=fedora-28&arch=x86_64"
}

pylorax.api.projects.source_to_repo(source, dnf_conf)

Return a dnf Repo object created from a source dict

Parameters:source (dict) -- A Weldr source dict Returns:A dnf Repo object Return type:dnf.Repo

Example:

{
  "check_gpg": True,
  "check_ssl": True,
  "gpgkey_urls": [
    "file:///etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-28-x86_64"
  ],
  "name": "fedora",
  "proxy": "http://proxy.brianlane.com:8123",
  "system": True
  "type": "yum-metalink",
  "url": "https://mirrors.fedoraproject.org/metalink?repo=fedora-28&arch=x86_64"
}

pylorax.api.queue module

pylorax.api.recipes module

class pylorax.api.recipes.CommitDetails(commit, timestamp, message, revision=None)

Bases: pylorax.base.DataHolder

exception pylorax.api.recipes.CommitTimeValError

Bases: Exception

pylorax.api.recipes.NewRecipeGit(toml_dict)

Create a RecipeGit object from fields in a TOML dict

Parameters:

• rpmname (str) -- Name of the rpm to create, also used as the prefix name in the tar archive
• rpmversion (str) -- Version of the rpm, eg. "1.0.0"
• rpmrelease (str) -- Release of the rpm, eg. "1"
• summary (str) -- Summary string for the rpm
• repo (str) -- URL of the get repo to clone and create the archive from
• ref (str) -- Git reference to check out. eg. origin/branch-name, git tag, or git commit hash
• destination (str) -- Path to install the / of the git repo at when installing the rpm

Returns:

A populated RecipeGit object

Return type:

RecipeGit

The TOML should look like this:

[[repos.git]]
rpmname="server-config"
rpmversion="1.0"
rpmrelease="1"
summary="Setup files for server deployment"
repo="PATH OF GIT REPO TO CLONE"
ref="v1.0"
destination="/opt/server/"

Note that the repo path supports anything that git supports, file://, https://, http://

Currently there is no support for authentication

class pylorax.api.recipes.Recipe(name, description, version, modules, packages, groups, customizations=None, gitrepos=None)

Bases: dict

A Recipe of package and modules

This is a subclass of dict that enforces the constructor arguments and adds a .filename property to return the recipe's filename, and a .toml() function to return the recipe as a TOML string.

bump_version(old_version=None)

semver recipe version number bump

Parameters:old_version (str) -- An optional old version number Returns:The new version number or None Return type:str Raises:ValueError

If neither have a version, 0.0.1 is returned If there is no old version the new version is checked and returned If there is no new version, but there is a old one, bump its patch level If the old and new versions are the same, bump the patch level If they are different, check and return the new version

filename

Return the Recipe's filename

Replaces spaces in the name with '-' and appends .toml

freeze(deps)

Return a new Recipe with full module and package NEVRA

Parameters:deps (list() -- A list of dependency NEVRA to use to fill in the modules and packages Returns:A new Recipe object Return type:Recipe

group_names

Return the names of the groups. Groups do not have versions.

module_names

Return the names of the modules

module_nver

Return the names and version globs of the modules

package_names

Return the names of the packages

package_nver

Return the names and version globs of the packages

toml()

Return the Recipe in TOML format

exception pylorax.api.recipes.RecipeError

Bases: Exception

exception pylorax.api.recipes.RecipeFileError

Bases: Exception

class pylorax.api.recipes.RecipeGit(rpmname, rpmversion, rpmrelease, summary, repo, ref, destination)

Bases: dict

class pylorax.api.recipes.RecipeGroup(name)

Bases: dict

class pylorax.api.recipes.RecipeModule(name, version)

Bases: dict

class pylorax.api.recipes.RecipePackage(name, version)

Bases: pylorax.api.recipes.RecipeModule

pylorax.api.recipes.commit_recipe(repo, branch, recipe)

Commit a recipe to a branch

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• recipe (Recipe) -- Recipe to commit

Returns:

OId of the new commit

Return type:

Git.OId

Raises:

Can raise errors from Ggit

pylorax.api.recipes.commit_recipe_directory(repo, branch, directory)

Commit all *.toml files from a directory, if they aren't already in git.

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• directory (str) -- The directory of *.toml recipes to commit

Returns:

None

Raises:

Can raise errors from Ggit or RecipeFileError

Files with Toml or RecipeFileErrors will be skipped, and the remainder will be tried.

pylorax.api.recipes.commit_recipe_file(repo, branch, filename)

Commit a recipe file to a branch

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• filename (str) -- Path to the recipe file to commit

Returns:

OId of the new commit

Return type:

Git.OId

Raises:

Can raise errors from Ggit or RecipeFileError

pylorax.api.recipes.delete_file(repo, branch, filename)

Delete a file from a branch.

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• filename (str) -- filename to delete

Returns:

OId of the new commit

Return type:

Git.OId

Raises:

Can raise errors from Ggit

pylorax.api.recipes.delete_recipe(repo, branch, recipe_name)

Delete a recipe from a branch.

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• recipe_name (str) -- Recipe name to delete

Returns:

OId of the new commit

Return type:

Git.OId

Raises:

Can raise errors from Ggit

pylorax.api.recipes.diff_items(title, old_items, new_items)

Return the differences between two lists of dicts.

Parameters:

• title (str) -- Title of the entry
• old_items (list(dict)) -- List of item dicts with "name" field
• new_items (list(dict)) -- List of item dicts with "name" field

Returns:

List of diff dicts with old/new entries

Return type:

list(dict)

pylorax.api.recipes.find_commit_tag(repo, branch, filename, commit_id)

Find the tag that matches the commit_id

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• filename (str) -- filename to revert
• commit_id (Git.OId) -- The commit id to check

Returns:

The tag or None if there isn't one

Return type:

str or None

There should be only 1 tag pointing to a commit, but there may not be a tag at all.

The tag will look like: 'refs/tags/<branch>/<filename>/r<revision>'

pylorax.api.recipes.find_name(name, lst)

Find the dict matching the name in a list and return it.

Parameters:

• name (str) -- Name to search for
• lst -- List of dict's with "name" field

Returns:

First dict with matching name, or None

Return type:

dict or None

pylorax.api.recipes.get_commit_details(commit, revision=None)

Return the details about a specific commit.

Parameters:

• commit (Git.Commit) -- The commit to get details from
• revision (int) -- Optional commit revision

Returns:

Details about the commit

Return type:

CommitDetails

Raises:

CommitTimeValError or Ggit exceptions

pylorax.api.recipes.get_revision_from_tag(tag)

Return the revision number from a tag

Parameters:tag (str) -- The tag to exract the revision from Returns:The integer revision or None Return type:int or None

The revision is the part after the r in 'branch/filename/rXXX'

pylorax.api.recipes.gfile(path)

Convert a string path to GFile for use with Git

pylorax.api.recipes.head_commit(repo, branch)

Get the branch's HEAD Commit Object

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name

Returns:

Branch's head commit

Return type:

Git.Commit

Raises:

Can raise errors from Ggit

pylorax.api.recipes.is_commit_tag(repo, commit_id, tag)

Check to see if a tag points to a specific commit.

Parameters:

• repo (Git.Repository) -- Open repository
• commit_id (Git.OId) -- The commit id to check
• tag (str) -- The tag to check

Returns:

True if the tag points to the commit, False otherwise

Return type:

bool

pylorax.api.recipes.is_parent_diff(repo, filename, tree, parent)

Check to see if the commit is different from its parents

Parameters:

• repo (Git.Repository) -- Open repository
• filename (str) -- filename to revert
• tree (Git.Tree) -- The commit's tree
• parent (Git.Commit) -- The commit's parent commit

Retuns:

True if filename in the commit is different from its parents

Return type:

bool

pylorax.api.recipes.list_branch_files(repo, branch)

Return a sorted list of the files on the branch HEAD

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name

Returns:

A sorted list of the filenames

Return type:

list(str)

Raises:

Can raise errors from Ggit

pylorax.api.recipes.list_commit_files(repo, commit)

Return a sorted list of the files on a commit

Parameters:

• repo (Git.Repository) -- Open repository
• commit (str) -- The commit hash to list

Returns:

A sorted list of the filenames

Return type:

list(str)

Raises:

Can raise errors from Ggit

pylorax.api.recipes.list_commits(repo, branch, filename, limit=0)

List the commit history of a file on a branch.

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• filename (str) -- filename to revert
• limit (int) -- Number of commits to return (0=all)

Returns:

A list of commit details

Return type:

list(CommitDetails)

Raises:

Can raise errors from Ggit

pylorax.api.recipes.open_or_create_repo(path)

Open an existing repo, or create a new one

Parameters:path (string) -- path to recipe directory Returns:A repository object Return type:Git.Repository Raises:Can raise errors from Ggit

A bare git repo will be created in the git directory of the specified path. If a repo already exists it will be opened and returned instead of creating a new one.

pylorax.api.recipes.prepare_commit(repo, branch, builder)

Prepare for a commit

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• builder (TreeBuilder) -- instance of TreeBuilder

Returns:

(Tree, Sig, Ref)

Return type:

tuple

Raises:

Can raise errors from Ggit

pylorax.api.recipes.read_commit(repo, branch, filename, commit=None)

Return the contents of a file on a specific branch or commit.

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• filename (str) -- filename to read
• commit (str) -- Optional commit hash

Returns:

The commit id, and the contents of the commit

Return type:

tuple(str, str)

Raises:

Can raise errors from Ggit

If no commit is passed the master:filename is returned, otherwise it will be commit:filename

pylorax.api.recipes.read_commit_spec(repo, spec)

Return the raw content of the blob specified by the spec

Parameters:

• repo (Git.Repository) -- Open repository
• spec (str) -- Git revparse spec

Returns:

Contents of the commit

Return type:

str

Raises:

Can raise errors from Ggit

eg. To read the README file from master the spec is "master:README"

pylorax.api.recipes.read_recipe_and_id(repo, branch, recipe_name, commit=None)

Read a recipe commit and its id from git

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• recipe_name (str) -- Recipe name to read
• commit (str) -- Optional commit hash

Returns:

The commit id, and a Recipe object

Return type:

tuple(str, Recipe)

Raises:

Can raise errors from Ggit

If no commit is passed the master:filename is returned, otherwise it will be commit:filename

pylorax.api.recipes.read_recipe_commit(repo, branch, recipe_name, commit=None)

Read a recipe commit from git and return a Recipe object

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• recipe_name (str) -- Recipe name to read
• commit (str) -- Optional commit hash

Returns:

A Recipe object

Return type:

Recipe

Raises:

Can raise errors from Ggit

If no commit is passed the master:filename is returned, otherwise it will be commit:filename

pylorax.api.recipes.recipe_diff(old_recipe, new_recipe)

Diff two versions of a recipe

Parameters:

• old_recipe (Recipe) -- The old version of the recipe
• new_recipe (Recipe) -- The new version of the recipe

Returns:

A list of diff dict entries with old/new

Return type:

list(dict)

pylorax.api.recipes.recipe_filename(name)

Return the toml filename for a recipe

Replaces spaces with '-' and appends '.toml'

pylorax.api.recipes.recipe_from_dict(recipe_dict)

Create a Recipe object from a plain dict.

Parameters:recipe_dict (dict) -- A plain dict of the recipe Returns:A Recipe object Return type:Recipe Raises:RecipeError

pylorax.api.recipes.recipe_from_file(recipe_path)

Return a recipe file as a Recipe object

Parameters:recipe_path (str) -- Path to the recipe fila Returns:A Recipe object Return type:Recipe

pylorax.api.recipes.recipe_from_toml(recipe_str)

Create a Recipe object from a toml string.

Parameters:recipe_str (str) -- The Recipe TOML string Returns:A Recipe object Return type:Recipe Raises:TomlError

pylorax.api.recipes.repo_file_exists(repo, branch, filename)

Return True if the filename exists on the branch

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• filename (str) -- Filename to check

Returns:

True if the filename exists on the HEAD of the branch, False otherwise.

Return type:

bool

pylorax.api.recipes.revert_file(repo, branch, filename, commit)

Revert the contents of a file to that of a previous commit

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• filename (str) -- filename to revert
• commit (str) -- Commit hash

Returns:

OId of the new commit

Return type:

Git.OId

Raises:

Can raise errors from Ggit

pylorax.api.recipes.revert_recipe(repo, branch, recipe_name, commit)

Revert the contents of a recipe to that of a previous commit

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• recipe_name (str) -- Recipe name to revert
• commit (str) -- Commit hash

Returns:

OId of the new commit

Return type:

Git.OId

Raises:

Can raise errors from Ggit

pylorax.api.recipes.tag_file_commit(repo, branch, filename)

Tag a file's most recent commit

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• filename (str) -- Filename to tag

Returns:

Tag id or None if it failed.

Return type:

Git.OId

Raises:

Can raise errors from Ggit

This uses git tags, of the form refs/tags/<branch>/<filename>/r<revision> Only the most recent recipe commit can be tagged to prevent out of order tagging. Revisions start at 1 and increment for each new commit that is tagged. If the commit has already been tagged it will return false.

pylorax.api.recipes.tag_recipe_commit(repo, branch, recipe_name)

Tag a file's most recent commit

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• recipe_name (str) -- Recipe name to tag

Returns:

Tag id or None if it failed.

Return type:

Git.OId

Raises:

Can raise errors from Ggit

Uses tag_file_commit()

pylorax.api.recipes.write_commit(repo, branch, filename, message, content)

Make a new commit to a repository's branch

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• filename (str) -- full path of the file to add
• message (str) -- The commit message
• content (str) -- The data to write

Returns:

OId of the new commit

Return type:

Git.OId

Raises:

Can raise errors from Ggit

pylorax.api.regexes module

pylorax.api.server module

pylorax.api.timestamp module

pylorax.api.timestamp.timestamp_dict(destdir)

pylorax.api.timestamp.write_timestamp(destdir, ty)

pylorax.api.v0 module

pylorax.api.workspace module

pylorax.api.workspace.workspace_delete(repo, branch, recipe_name)

Delete the recipe from the workspace

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• recipe_name (str) -- The name of the recipe

Returns:

None

Raises:

IO related errors

pylorax.api.workspace.workspace_dir(repo, branch)

Create the workspace's path from a Repository and branch

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name

Returns:

The path to the branch's workspace directory

Return type:

str

pylorax.api.workspace.workspace_read(repo, branch, recipe_name)

Read a Recipe from the branch's workspace

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• recipe_name (str) -- The name of the recipe

Returns:

The workspace copy of the recipe, or None if it doesn't exist

Return type:

Recipe or None

Raises:

RecipeFileError

pylorax.api.workspace.workspace_write(repo, branch, recipe)

Write a recipe to the workspace

Parameters:

• repo (Git.Repository) -- Open repository
• branch (str) -- Branch name
• recipe (Recipe) -- The recipe to write to the workspace

Returns:

None

Raises:

IO related errors

Module contents

pylorax.api.crossdomain(origin, methods=None, headers=None, max_age=21600, attach_to_all=True, automatic_options=True)