Introduction

Tools of the development environment can be on top of this API.

Plugins like builders should be at the bottom of this API. The current implementation mainly use plugins for Git and Buildroot.

Project

exception modules.project.ComponentNotFoundForDomain(domain)

exception modules.project.NoPluginForService(service)

class modules.project.Project(path, bare=False, repo_path=None)

Main class to describe/manage the project

add_component()

add_profile(profile)

add a profile from the current version

add_split(version)

add_tool()

build()

build_bootloader()

build_kernel()

build_rootfs()

build_toolchain()

component_exists(name)

Service: return True if package already in Plugin

config_commit(comment, amend=False)

commit config

config_has_changes()

check local changes not committed

config_is_published()

check commits not pushed to the repository

config_is_updated()

check remote changes not merged

config_is_writeable()

no commit can be done if not on a branch

config_publish()

push config commits to the repository

configure()

create_component(name, local_paths, target_directory, pkg_description=None, help='No help')

Service: Add directory to the target rootfs

elements_are_published()

check commits not pushed to the repositories

elements_are_updated()

check remote changes not merged

elements_have_changes()

check local changes not committed

elements_match_config()

check if versions of all elements match the global configuration

get_available_measures()

Return list of available measures

get_build_command()

get_config_ref(version=None, profile=None)

return tag or branch of the nearest version/profile for the specified version/profile

get_desc()

get_deselected_components()

get_deselected_tools()

get_install_bootloader_command()

get_install_kernel_command()

get_install_rootfs_command()

get_last_config_comment()

message of HEAD

get_latest_release()

first part of current or previous tag name (before ‘#’) of the current branch

get_measure(measure_type, ref=None)

Return a tuple (ref, measure) or None

get_measures(measure_type, ref=None)

Return a list of tuple [(ref, measure), ...] or None

get_name()

get_path()

get_profile()

second part of current branch name (after ‘#’)

get_profiles(version_split=None, release=None)

second part of branches names (after ‘#’) of the current version

get_releases(version_split=None)

first part of tags names (before ‘#’)

get_run_command()

get_selected_components()

return list of Component() objects

get_selected_tools()

get_version()

current release or split

get_version_split()

first part of current branch name (before ‘#’)

get_version_splits()

first part of branches names (before ‘#’)

get_versions()

lists of releases in a dict of splits

install_all()

install_bootloader()

install_kernel()

install_rootfs()

is_released()

check if last commit is tagged

jump(ref)

try to checkout config at ref and jump elements if possible

run()

set_desc(desc)

set_install_bootloader_command(command)

set_install_kernel_command(command)

set_install_rootfs_command(command)

set_measure_path(path=None)

Instanciate Measure object with ‘path’

set_name(name)

set_release(release)

create a new tag for the current version/profile

set_run_command(command)

view_serial_line(device='/dev/ttyUSB0', dry_run=False)

exception modules.project.ProjectError

modules.project.create_project(path, config_to_clone=None, bare=False, repo_path=None)

modules.project.get_template_location(template_name)

modules.project.get_templates()

modules.project.open_project(path, bare=False, repo_path=None)

class plugins.config.Config(path, top_dir=None)

Basic methods about config directory

get_global_dict()

get_global_value(key)

get_path()

get_plugins_for(service)

return plugins objects which are configured and implement service()

get_ref(version, profile)

return branch or tag

get_top_dir()

set_global_value(key, value)

exception plugins.config.ConfigError

plugins.config.get_profile_from(branch)

second part of branch name (after ‘#’)

plugins.config.get_version_from(branch)

first part of branch name (before ‘#’)

Element

Component and Tool are inherited of Element.

class modules.component.Component(name, config=None, default_path=None, bare=False)

components are elements which are built for the target

get_builder()

get_domain()

get_path()

modules.component.get_all_components(config)

class modules.tool.Tool(name, config=None, default_path=None, bare=False)

tools are elements which are used on the host

get_builder()

get_path()

class modules.element.Element(name, category, global_conf, default_path=None, bare=False)

Base class for tools and components

bookmark()

checkout()

checkout configured version

clone(default_from=None)

clone from configured repository or default_from

configure()

Open interactive configurator

create_repository()

deselect()

get_configured_ref()

return dict {commit, name, type, head} of branch or tag referenced in location_uri match remote HEAD if location_uri doesn’t contain any ref

get_configured_version(auto=True)

get_current_version()

get_location_name()

return name of location or None if not

get_name()

get_repository()

has_repository()

is_bookmarked()

is_configurable()

Return True if element is Configurable itself. For example, buildroot, linux, busybox are self configurable via menuconfig

is_selected()

return True, False or None if unspecified

remove()

select()

set_repository(uri, access_type=None)

set_version(version)

unbookmark()

unselect()

class modules.element.ElementConf(save, *args, **kw)

has(key)

is_set(key, default=False)

remove(key)

set(key, value='yes')

exception modules.element.ElementError

base class for element Error

Infos

exception modules.licence.BadElementType(err)

exception modules.licence.ElementNotFound(err)

exception modules.licence.LicenceError(err)

Base class for exceptions in this module

class modules.licence.LicenceManager(db='/home/tmonjalo/projets/rtel4i/rtel4i-open/src/middleware/doc/source/../../modules/licences.db')

Base class for managing licences associations with components and tools (elements)

add_element(element, type, licence)

add element in licence db

add_licence(slug, name, url)

add licence in db

create_db()

setup a empty DB

get_elements(licence)

get all elements for licence

get_licence(element)

get licence name for element

get_licence_detail(licence)

get detailled info on licence

get_licences()

get all licences

get_licences_of_elements()

get all licences used

insert_db(query, values)

wrapper for insert queries

exception modules.licence.LicenceNotFound(err)

class modules.measure.Measure(repo_path)

Class to get measures informations

get_available_measures(refresh=False)

Return a list of available measures

get_measure(measure_type, ref)

get_path()

Repos

class plugins.location.Location(full_uri, access_type=None)

Usefull class to clone various type of project repository

clone(dest)

get_type()

classmethod get_types()

get_uri()

get_version()

http_get(dest)

exception plugins.location.LocationError

class plugins.location.TarFile(filename=None)

redefine TarFile to be with-compliant

plugins.location.get_uri_type(uri)

class plugins.gitrepo.GitCommit(repo, sha, tree=None, author=None, authored_date=None, author_tz_offset=None, committer=None, committed_date=None, committer_tz_offset=None, message=None, parents=None)

get_age()

return relative time since the commit date. note: If you want the absolute time, use self.committed_date instead

get_branch()

Check if commit correspond to a head of branch return Branch or None

get_parent_branch()

Return branch if commit is on head or a parent branch

get_tag()

Check if commit correspond to a tag. return Tag or None

exception plugins.gitrepo.GitNoBranchError

Thrown when head is in strange state (Not in any branch ?). (Can be happened when rebasing for example)

class plugins.gitrepo.GitRepo

Git tools on top of GitPython

checkout(ref)

commit(comment, amend=False)

get_branch_refs(ref)

return ordered tags and branch head for branch which contains ref

get_branches()

get_commit_message(ref=None, short=False)

Return the last commit message or None if ref doesn’t exist. If short is enable, just return the summary message

get_current_branch()

get_current_commit()

return SHA for HEAD

get_current_ref()

return dict {commit, name, type} for HEAD

get_head_tags(branch=None)

get_latest_tag(branch=None)

get_latest_tags(branch=None)

get_ref_branch(ref)

return branch which contains ref

get_tags(branches=None)

get_tracked_branch()

has_changes()

is_published()

is_tagged(branch=None)

is_updated()

is_writeable()

publish()

refresh()

set_tag(tag)

start_branch(branch)

exception plugins.gitrepo.GitRepoError

Base Class for GitRepo Exception

Builder

class plugins.buildroot.Buildroot(config)

Buildroot plugin

build()

build_bootloader()

build_kernel()

build_menuconfig()

Handy function, but not used in main build process

build_rootfs()

build_toolchain()

check_install()

Check if buildroot is installed Check if Makefile is present

component_exists(pkg_name)

Return True if package is in Buildroot

classmethod configure(config)

configure_component(name)

Exec the interactive configure script for a component

create_component(name, local_paths, target_directory, pkg_description=None, help='No help')

make buildroot custom package Use makefile.basic.in (currently in buildroot-ow). Generate .mk file and Config entries. name, local_paths and target_directory are mandatory. local_paths = list of files and paths to add to target_directory package_description, force and help are not mandatory.

get_element_path(name)

Return the element build directory from buildroot, or None if it could not find it

get_selected_components()

get_self_configurable_cmd(name)

Get cmd for configurable components. Ex: (‘linux’) -> returns ‘linux26-menuconfig’

make_link_for_external_component(comp_name, comp_path)

Make symlink for component which must be built by buildroot but are in different path comp_name : component Name comp_path : Real component Path

exception plugins.buildroot.BuildrootError

Base class for Buildroot Plugin Exception

exception plugins.buildroot.BuildrootNotImplementedError(feature)

exception plugins.buildroot.ComponentNotSupported

get_component_path fail...

exception plugins.buildroot.ConfigFileError

Something wrong with Buildroot Config file

exception plugins.buildroot.InstallError

Buildroot cannot install

class plugins.common.kconfig.Kconfig(conf_file, prefix)

Handle get/set on configuration file of kconfig system

get_parameter(param)

get_selected_parameters()

is_selected(param)

Check if param is set in Config File

set_parameter(param, val)

class plugins.common.plugin.Plugin

Generic API for all plugins

classmethod configure(config)

static get_api_version()

classmethod get_doc()

classmethod get_name()

classmethod get_services()

class plugins.common.service.Service(name='', command_get='')

get_command()

get_name()