sugar4.bundle

Activity bundle management and packaging utilities.

Submodules

• sugar4.bundle.activitybundle
• sugar4.bundle.bundle
• sugar4.bundle.bundleversion
• sugar4.bundle.contentbundle
• sugar4.bundle.helpers

Exceptions

InvalidVersionError

A version cannot be normalized, because:

Classes

ActivityBundle	A Sugar activity bundle
Bundle	A Sugar activity, content module, etc.
NormalizedVersion	Normalize a version string.
ContentBundle	A Sugar content bundle

Package Contents

class sugar4.bundle.ActivityBundle(path, translated=True)

Bases: sugar4.bundle.bundle.Bundle

A Sugar activity bundle

See http://wiki.sugarlabs.org/go/Development_Team/Almanac/Activity_Bundles for details

MIME_TYPE = 'application/vnd.olpc-sugar'

bundle_exec = None

get_locale_path()

Get the locale path inside the (installed) activity bundle.

get_icons_path()

Get the icons path inside the (installed) activity bundle.

get_name()

Get the activity user-visible name.

get_bundle_id()

Get the activity bundle id

get_icon()

Get the activity icon name

get_icon_filename()

Get the icon file name

get_activity_version()

Get the activity version

get_command()

Get the command to execute to launch the activity factory

get_mime_types()

Get the MIME types supported by the activity

get_tags()

Get the tags that describe the activity

get_summary()

Get the summary that describe the activity

get_description()

Get the description for the activity. The description is a pace of multi paragraph text about the activity. It is written in a HTML subset using only the p, ul, li and ol tags.

get_single_instance()

Get whether there should be a single instance for the activity

get_max_participants()

Get maximum number of participants in share

get_show_launcher()

Get whether there should be a visible launcher for the activity

install()

install_mime_type(install_path)

Update the mime type database and install the mime type icon

uninstall(force=False, delete_profile=False)

is_user_activity()

class sugar4.bundle.Bundle(path)

Bases: object

A Sugar activity, content module, etc.

The bundle itself may be either a zip file or a directory hierarchy, with metadata about the bundle stored various files inside it.

This is an abstract base class. See ActivityBundle and ContentBundle for more details on those bundle types.

__del__()

get_file(filename)

is_file(filename)

is_dir(filename)

get_path()

Get the bundle path.

get_installation_time()

Get a timestamp representing the time at which this activity was installed.

get_show_launcher()

class sugar4.bundle.NormalizedVersion(activity_version)

Bases: object

Normalize a version string.

Parameters:

activity_version (str) – the version string

Raises:

InvalidVersionError –

parts

the numeric parts of the version after normalization.

Type:

list

parts = []

__str__()

__repr__()

__eq__(other)

__lt__(other)

__ne__(other)

__gt__(other)

__le__(other)

__ge__(other)

exception sugar4.bundle.InvalidVersionError

Bases: Exception

A version cannot be normalized, because:

• the object is not a string,

• the string does not match the regular expression, or

• the string has a leading zero in a version part.

Initialize self. See help(type(self)) for accurate signature.

class sugar4.bundle.ContentBundle(path)

Bases: sugar4.bundle.bundle.Bundle

A Sugar content bundle

See http://wiki.laptop.org/go/Content_bundles for details

MIME_TYPE = 'application/vnd.olpc-content'

get_name()

get_library_version()

get_locale()

get_activity_start()

get_icon()

get_start_uri()

get_bundle_id()

get_activity_version()

get_tags()

install()

uninstall(force=False, delete_profile=False)

is_user_activity()