sugar4.activity.bundlebuilder

The bundle builder is a build system for Sugar activities. Usually, it is setup by creating a setup.py file in the project with the following:

#!/usr/bin/env python

from sugar4.activity import bundlebuilder
bundlebuilder.start()

Attributes

`IGNORE_DIRS`
`IGNORE_FILES`

Classes

`Config`
`Builder`
`Packager`
`XOPackager`
`SourcePackager`
`Installer`

Functions

`list_files`(base_dir[, ignore_dirs, ignore_files])
`cmd_check`(config, options)	Run tests for the activity
`cmd_dev`(config, options)	Setup for development
`cmd_dist_xo`(config, options)	Create a xo bundle package
`cmd_fix_manifest`(config, options)	Add missing files to the manifest (OBSOLETE)
`cmd_dist_source`(config, options)	Create a tar source package
`cmd_install`(config, options)	Install the activity in the system
`cmd_genpot`(config, options)	Generate the gettext pot file
`cmd_build`(config, options)	Build generated files
`start`()

Module Contents

sugar4.activity.bundlebuilder.IGNORE_DIRS = ['dist', '.git', 'screenshots'][source]

sugar4.activity.bundlebuilder.IGNORE_FILES = ['.gitignore', 'MANIFEST', '*.pyc', '*~', '*.bak', 'pseudo.po'][source]

sugar4.activity.bundlebuilder.list_files(base_dir, ignore_dirs=None, ignore_files=None)[source]

class sugar4.activity.bundlebuilder.Config(source_dir, dist_dir=None, dist_name=None)[source]

Bases: object

source_dir[source]

build_dir[source]

dist_dir[source]

dist_name = None[source]

bundle = None[source]

version = None[source]

activity_name = None[source]

bundle_id = None[source]

bundle_name = None[source]

bundle_root_dir = None[source]

tar_root_dir = None[source]

xo_name = None[source]

tar_name = None[source]

summary = None[source]

description = None[source]

update()[source]

class sugar4.activity.bundlebuilder.Builder(config, no_fail=False)[source]

Bases: object

config[source]

locale_dir[source]

build()[source]

build_locale()[source]

get_locale_files()[source]

class sugar4.activity.bundlebuilder.Packager(config)[source]

Bases: object

config[source]

package_path = None[source]

get_files_in_git(root=None)[source]

class sugar4.activity.bundlebuilder.XOPackager(builder)[source]

Bases: Packager

builder[source]

package_path[source]

package()[source]

class sugar4.activity.bundlebuilder.SourcePackager(config)[source]

Bases: Packager

package_path[source]

package()[source]

class sugar4.activity.bundlebuilder.Installer(builder)[source]

Bases: Packager

builder[source]

install(destdir, prefix, install_mime=True, install_desktop_file=True)[source]

sugar4.activity.bundlebuilder.cmd_check(config, options)[source]: Run tests for the activity

sugar4.activity.bundlebuilder.cmd_dev(config, options)[source]: Setup for development

sugar4.activity.bundlebuilder.cmd_dist_xo(config, options)[source]: Create a xo bundle package

sugar4.activity.bundlebuilder.cmd_fix_manifest(config, options)[source]: Add missing files to the manifest (OBSOLETE)

sugar4.activity.bundlebuilder.cmd_dist_source(config, options)[source]: Create a tar source package

sugar4.activity.bundlebuilder.cmd_install(config, options)[source]: Install the activity in the system

sugar4.activity.bundlebuilder.cmd_genpot(config, options)[source]: Generate the gettext pot file

sugar4.activity.bundlebuilder.cmd_build(config, options)[source]: Build generated files

sugar4.activity.bundlebuilder.start()[source]