Difference between revisions of "Platform Team/Package Management System"

From Sugar Labs
Jump to navigation Jump to search
Line 34: Line 34:
 
== Dictionary ==
 
== Dictionary ==
  
 +
A list of terms to understand basic conceptions.
  
 +
'''Zero Install''', '''0install'''<br>
 +
Decentralized cross-distribution software installation system that ''Sweets'' is based on.
 +
 +
'''Sweets'''<br>
 +
Package management wrapper around ''Zero Install''.
 +
 +
'''sweet''', '''sweet project'''<br>
 +
Distribution entities in ''Sweets'', i.e., packages. In other words, software projects that have ''recipe'' files in their sources that are being released via ''Sweets''.
 +
 +
'''feed'''<br>
 +
A file in [http://0install.net/interface-spec.html XML notation] that contains information about all possible variants of a software, i.e., ''implementations'', that can be launched.
 +
 +
'''interface'''<br>
 +
This is the corner stone of ''Zero Install'' and, thus, ''Sweets'' as well. To make a ''feed'' useful for other people, they are placed somewhere ([[Platform_Team/Infrastructure|http://sweets.sugarlabs.org]] in case of ''Sweets'') in the Internet for being accessible via HTTP/FTP. The full Web url, such as http://0install.net/2006/interfaces/ZeroInstall-GUI.xml, is an unique identifier of a distribution entity within ''Zero Install''/''Sweets'' and named the ''interface''.
 +
Only this url is needed to run software from everywhere if there is a connection to the Internet.
 +
 +
'''implementation'''<br>
 +
One or several bundles that contain one particular implementation of software projects that are being distributed via ''Zero Install''. ''Implementations'' are being [[Platform_Team/Recipe_Specification|attributed]] with versions, stability levels, targeted machine architectures and OS types. It is possible to have several implementations for the same software version if there are differences between launching them on different OSes or machine architectures. Another important attribute of ''implementations'' are dependencies of this particular ''implementation'', formed as a list of ''interfaces''. ''Feeds'' contain information about all existed implementations to let ''Zero Install'' choose the right one on the client side taking into account tons of details like machine architecture, OS type, stability levels or dependency restrictions.
 +
 +
'''recipe'''<br>
 +
On ''Zero Install'' level, developers work with ''feeds'' manually. In case of ''Sweets'', the regular way is [[Platform_Team/Recipe_Specification|using]] ''recipes'' (but it is still possible to fallback to ''feeds'' all time). In short, it is an analog of spec files in GNU/Linux distributions, e.g., RPM {{Code|.spec}} files or {{Code|debian/}} directories in Debian. ''Recipes'' do not specify ready-to-launch ''implementations'' like ''feeds'' do, but only describe the last software version. The ''feed'' will be generated automatically on [[Platform_Team/Infrastructure|a server]] (with preserving the history of versions) after [[Platform_Team/Guide/Sweets_Packaging|releasing]] new version of the software.
 +
 +
'''Short form for sweet interfaces'''<br>
 +
Within ''Sweets'', it is possible to omit {{Code|http://sweets.sugarlabs.org/}} prefix for sweet ''interfaces'' to make usage more expressive, e.g., in ''recipe'' files. It is all time possible to use full ''interfaces''.
 +
 +
'''Implemented interfaces'''<br>
 +
One particular ''sweet'' implements, [[Platform_Team/Recipe_Specification#Common_options|according]] to ''recipe'' files, one or several ''interfaces''. The reason to have several ''interfaces'' is that the same ''sweet'' might represent it self, e.g., http://sweets.sugarlabs.org/~alsroot/browse, and the upstream ''sweet'' that was used as a basis for current one, e.g., http://sweets.sugarlabs.org/browse. Further on client side, it will be possible to get implementations from {{Code|~alsroot/browse}} while launching {{Code|browse}} ''sweet''.
 +
 +
'''Associated interfaces'''<br>
 +
''Associated interfaces'' is the different way to setup upstream-downstream relations between ''interfaces''. If a ''recipe'' file [[Platform_Team/Recipe_Specification#Common_options|mentions]] some ''interfaces'' as ''associated'', ''implementations'' from these interfaces will be added to the ''implementations'' list of the current one. For example, if http://sweets.sugarlabs.org/sdk/sugar (pure ''sweet'' Sugar Shell) ''interface'' contains http://sweets.sugarlabs.org/base/sugar (an alias to natively packaged Sugar Shell) as an ''associated interface'', while launching {{Code|sdk/sugar}} it will be possible to run natively packaged sugar that came from the {{Code|base/sugar}}.
 +
 +
'''local sweet'''<br>
 +
It is an important high-level conception in ''Sweets'' that is intended to make development process of ''sweet'' projects more comfortable. Technically, it is sources of ''sweet'' project (i.e., with a ''recipe'' file) placed somewhere to files system and registered in local ''Sweets'' as a one ''implementation'' for ''interfaces'' it ''implements''. It is all time possible to run this ''local sweet'' directly be using the full files system path as an ''interface'', but the most useful feature is reusing ''local implementation'' in regular ''Sweets'' workflow. For example, if sugar-toolkit sources were cloned to {{Code|~/src/sugar-toolkit}} directory, while running {{Code|sugar}} ''sweet'', it will be possible to reuse local sugar-toolkit sources as a regular ''implementation''.
 +
 +
'''sweet package'''<br>
 +
Using http://packages.sugarlabs.org Web UI, it is possible to create a repository with native packages from released ''sweets''.
 +
 +
'''Sweets Distribution'''<br>
 +
It is a [http://download.sugarlabs.org/packages/SweetsDistribution:/ repository] with Glucose and Fructose ''sweet packages'' based on {{Code|sdk/}} ''sweets''.
  
 
== Further reading ==
 
== Further reading ==

Revision as of 11:37, 4 September 2011

Summary

Sweets is a Package Management System based on Zero Install, a decentralized cross-distribution software installation system. It is intended to distribute various software projects created in the Sugar ecosystem, such as libraries, sugar itself, and sugar activities.

This new distribution method is initiated assuming that:

  • The method to share software projects should to be as convenient as possible.
  • It is important to stimulate users into becoming doers, to modify existing activities, and to share the results of their experiments with other people, i.e., a distribution method should handle different variants of the same project.
  • This distribution method is not intended to be the only one, but is targeted more towards direct distribution—from software creators to software users.

The purpose is to create a new distribution method instead of reusing:

  1. .xo bundles
    • Work smoothly only for pure python activities, and only if all (and the same) dependencies are installed on all systems. They stop working smoothly if activities use non-standard dependencies or contain binaries.
    • But, are not effective in supporting the use of multiple versions of software, e.g., the results of experiments (the work) of different doers, simultaneously. Users must manually handle the variety of activity versions, e.g., sort out all the local bundles or directories in ~/Activities.
  2. native packages
    • Not the shortest way to connect developers with users.
    • In most cases, they don't support multiple versions of the same project.
    • They don't work at all for sharing results of experiments.

At the same time, existing distribution methods are reused in Sweets:

  1. .xo bundles is a subset of the Sweets workflow
    • It is possible to bundle an entire directory as a sweet project to use it as a regular .xo file.
  2. native packages
    • Sweets is not intended to create one more GNU/Linux distribution. It distributes only projects that people create within the Sugar community; all other software, i.e., dependencies, will be reused from native packages.
    • For cases like Sugar deployments, using the more centralized, regular repositories (third party or official GNU/Linux distributions with native packages) makes more sense. These native packages of Sugar software will be included in Sweets, as well. When people start using Sweets on top of these Sugar distributions, they will have the chance to choose between natively packaged Sugar components and components that came directly from software creators.
    • It is possible, when there is a need, to automatically package sweets into native packages. See Sweets Distribution, for example.

Zero Install basis

Sweets is entirely based on Zero Install. Sweets might be treated as a tools and infrastructure wrapper around Zero Install. See Zero Install's home page, http://0install.net/, for detailed information. And the design page in particular.

Dictionary

A list of terms to understand basic conceptions.

Zero Install, 0install
Decentralized cross-distribution software installation system that Sweets is based on.

Sweets
Package management wrapper around Zero Install.

sweet, sweet project
Distribution entities in Sweets, i.e., packages. In other words, software projects that have recipe files in their sources that are being released via Sweets.

feed
A file in XML notation that contains information about all possible variants of a software, i.e., implementations, that can be launched.

interface
This is the corner stone of Zero Install and, thus, Sweets as well. To make a feed useful for other people, they are placed somewhere (http://sweets.sugarlabs.org in case of Sweets) in the Internet for being accessible via HTTP/FTP. The full Web url, such as http://0install.net/2006/interfaces/ZeroInstall-GUI.xml, is an unique identifier of a distribution entity within Zero Install/Sweets and named the interface. Only this url is needed to run software from everywhere if there is a connection to the Internet.

implementation
One or several bundles that contain one particular implementation of software projects that are being distributed via Zero Install. Implementations are being attributed with versions, stability levels, targeted machine architectures and OS types. It is possible to have several implementations for the same software version if there are differences between launching them on different OSes or machine architectures. Another important attribute of implementations are dependencies of this particular implementation, formed as a list of interfaces. Feeds contain information about all existed implementations to let Zero Install choose the right one on the client side taking into account tons of details like machine architecture, OS type, stability levels or dependency restrictions.

recipe
On Zero Install level, developers work with feeds manually. In case of Sweets, the regular way is using recipes (but it is still possible to fallback to feeds all time). In short, it is an analog of spec files in GNU/Linux distributions, e.g., RPM .spec files or debian/ directories in Debian. Recipes do not specify ready-to-launch implementations like feeds do, but only describe the last software version. The feed will be generated automatically on a server (with preserving the history of versions) after releasing new version of the software.

Short form for sweet interfaces
Within Sweets, it is possible to omit http://sweets.sugarlabs.org/ prefix for sweet interfaces to make usage more expressive, e.g., in recipe files. It is all time possible to use full interfaces.

Implemented interfaces
One particular sweet implements, according to recipe files, one or several interfaces. The reason to have several interfaces is that the same sweet might represent it self, e.g., http://sweets.sugarlabs.org/~alsroot/browse, and the upstream sweet that was used as a basis for current one, e.g., http://sweets.sugarlabs.org/browse. Further on client side, it will be possible to get implementations from ~alsroot/browse while launching browse sweet.

Associated interfaces
Associated interfaces is the different way to setup upstream-downstream relations between interfaces. If a recipe file mentions some interfaces as associated, implementations from these interfaces will be added to the implementations list of the current one. For example, if http://sweets.sugarlabs.org/sdk/sugar (pure sweet Sugar Shell) interface contains http://sweets.sugarlabs.org/base/sugar (an alias to natively packaged Sugar Shell) as an associated interface, while launching sdk/sugar it will be possible to run natively packaged sugar that came from the base/sugar.

local sweet
It is an important high-level conception in Sweets that is intended to make development process of sweet projects more comfortable. Technically, it is sources of sweet project (i.e., with a recipe file) placed somewhere to files system and registered in local Sweets as a one implementation for interfaces it implements. It is all time possible to run this local sweet directly be using the full files system path as an interface, but the most useful feature is reusing local implementation in regular Sweets workflow. For example, if sugar-toolkit sources were cloned to ~/src/sugar-toolkit directory, while running sugar sweet, it will be possible to reuse local sugar-toolkit sources as a regular implementation.

sweet package
Using http://packages.sugarlabs.org Web UI, it is possible to create a repository with native packages from released sweets.

Sweets Distribution
It is a repository with Glucose and Fructose sweet packages based on sdk/ sweets.

Further reading

Getting involved

  • Report on bugs.
  • Read the HACKING file to know how to contribute with code.

Resources