Platform Team/Guide/Sweets Usage

This guide describes how to use Sugar Labs' Packaging Management System. See also introduction page and Packaging guide.

Installation

Required packages

At first, install PackageKit related packages. The following command will install two Polkit authentication agents, one for Gnome session (if you start sugar emulator from Gnome Desktop Environment) and LXPolkit that will be used from Sugar session.

Fedora specific instructions:

sudo yum install gnome-packagekit lxpolkit

Debian and Ubuntu specific instructons (there is no official package for LXPolkit?):

sudo apt-get install packagekit-gnome

Relogin from X session to let Gnome or Sugar start Polkit authentication agent.

Bundle install

wget http://download.sugarlabs.org/sweets/sweets/installer.sh
sh installer.sh

Relogin from X session to take into account new PATH environment variable value.

Sources install

This will be useful for people who prefer using sources.

• Clone sweets sources and install it (after the first run, you need to relogin to take into account the new PATH value, then just run sweets command):

git clone git://git.sugarlabs.org/sdk/sweets.git
cd sweets
git submodule init
git submodule update
./sweets upgrade

Upgrade

If sweets was installed from a bundle:

sweets upgrade

If sweets is being used from sources, pull new commits from cloned directory:

git pull origin master
git submodule update

Usage

Read the Sweets Glossary to understand the basic conception. The rest of the text will operate with following terms:

• SWEET, the full interface url, like http://sweets.sugarlabs.org/sdk/sugar, or the short one, like sdk/sugar;
• COMMAND, sweet's command that points how to run particular sweet; by default, sweets have only run command but it is possible to have several commands;
• VERSION, sweet's version

See the Sugar via Sweets section for real examples how use Sweets to run Sugar Shell.

Launch

To launch a sweet with verbatim passing optional ARGUMENTS:

sweets SWEET [ARGUMENTS]

Sometimes sweets support several launching command, it is possible to specify one during the launch:

sweets SWEET:COMMAND

To run particular, not the latest, version:

sweets SWEET[=|>=|<=VERSION]

To get the full list of available versions:

sweets status SWEET -v

To get information, e.g., a list of supported commands, about already known sweet:

sweets show SWEET

Troubleshooting

If sweets can't find proper implementation, see the e lines in the output of:

sweets status SWEET -vdd

Search

It is possible to search sweets among locally known ones and registered on http://sweets.sugarlabs.org (not yet implemented). The search is based on Xapian search engine. Thus, it is possible to use Xapian's query language.

For command format is:

sweets search QUERY

Notice that partial search is enabled. So, the query tele will be treated as tele* to search all words that start from tele.

sweets supports following search prefixes basing of recipe options:

• interface the first interface from implementations list, e.g., http://sweets.sugarlabs.org/sdk/sugar;
• sweet the first interface from implementations list in short Sweets notations, e.g., sdk/sugar;
• implement the list of implemented interfaces;
• associate the list of associated interface;
• name the short name of a sweet;
• summary sweet's summary;
• description long sweet's description;
• category list of category names;
• license list of licenses;
• type sweet's type, might be library, application or activity;
• keep if activity, that a sweet is representing, is favorited;
• tags the list of sweet's tags;
• mime_types the list of MIME types activity, that a sweet is representing, supports.

So, it possible to search only among particular sweet attributes, like name:telepathy to search only among sweet names.

sweets support additional notation for exact searching in form of prefix:=string. For example the query name:=sugar will find sweets only with exactly sugar name and omit names like sugar-base. If search string contains spaces, wrap it to double quotes, name:="Sugar Commander". Note, wildcards does not work in exact search case and asterisks will be treated literally.

Run sweets from X session

Place sweets invocation into your ~/.xsession file:

PATH=$HOME/.local/bin:$PATH
sweets sdk/sugar

and create a /usr/share/xsessions/sweets.desktop desktop file:

[Desktop Entry]
Encoding=UTF-8
Name=Sweets
GenericName=Sweets
Exec=/etc/X11/Xsession
Type=Application

Sugar via Sweets

There is sdk/sugar sweet that represents the whole Sucrose. For now, it supports the following versions:

• 0.88 stable Dextrose-2,
• 0.92 stable upstream 0.92 branch,
• 0.93 testing version of current upstream trunk with initial support of Sweets in the Shell.

Run sugar session without mentioning any version and the most recent (as possible) will be launched:

sweets sdk/sugar

Sugar sweet supports emulator command to run Sugar from Xephyr:

sweets sdk/sugar:emulator

Current limitations

• For now, sweets knowns only about the glucose dependencies to install them from native packages in Debian, Ubuntu, Fedora, Mandriva, openSUSE, and Gentoo.
• Activities can't reuse sweets benefits.

Feedback

• Submit your bug report.
• Ask your question on IRC channels, #sugar (not logged) or #sugar-newbies (logged).