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

From Sugar Labs
Jump to navigation Jump to search
m (link update)
 
(51 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{Draft}}
+
== Summary ==
−
{{TOCright}}
 
−
[[Category:Zero Sugar]]
 
  
−
== Zero Sugar Distribution ==
+
Sweets is a [http://en.wikipedia.org/wiki/Package_management_system Package Management System] entirely based on [http://0install.net/ 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.
  
−
Zero Sugar provides a method that is transparent for users and convenient for doers to deploy software across varying platforms as well as across Sugar releases. Zero Sugar is mainly targeted to support a direct, doer-to-user interaction model, i.e., shortcut the chain of transfer of doer-to-distributor-to-user (still, Zero Sugar could be  [[#Distributors|beneficial]] for distributors, since it unifies the deployment workflow).
+
This new distribution method is initiated with these assumptions:
  
−
== Benefits ==
+
* 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, viz., 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.
  
−
How Zero Sugar might be useful depending upon your point of view:
+
The goal is to create a new distribution method that goes beyond reusing the current methods:
  
−
See also [[Activity_Team/Zero_Sugar/Use_Cases|other]] use cases.
+
# [[Development_Team/Almanac/Activity_Bundles|''.xo bundles'']]
 +
#* Work smoothly only for pure python activities, though 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 simultaneous use of multiple versions of software, e.g., the results of experiments (the work) of different doers, in one environment. Users must manually handle the variety of activity versions, e.g., sort out all the local bundles or directories in {{Code|~/Activities}}.
 +
# ''native packages''
 +
#* Are 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.
  
−
=== Users ===
+
And, at the same time, the existing distribution methods are available for reuse in Sweets:
  
−
Users can run Sugar effortlessly in multiple environments (machine architectures, GNU/Linux distributions, etc.). And since Sugar also stimulates users to be doers, there can be tons of handmade software in the field (mostly duplicates and reinvented wheels, but this is the nature of learning with Sugar—one tries some software, realizes some missing or additional feature, modifies or mimics some code, learns something new, and eventually produces a new creation). It is becoming critical to provide an easy and robust launching scheme for all these pieces of code, without writing long HOWTOs somewhere on a wiki, like "Please, if you are on Ubuntu, install these packages before starting my activity...".
+
# [[Development_Team/Almanac/Activity_Bundles|''.xo bundles'']] are a subset of the Sweets workflow, from the usage point of view.
 +
#* It is possible to bundle an entire directory as a sweet project to use it as a regular .xo file.
 +
# ''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.
  
−
Relying only on a particular distributor, i.e., using activities only from one distributor's channel, makes Sugar less useful or universal. Zero Sugar provides the most convenient and direct deployment method possible between the author of a piece of code and its users.
+
See also the initial release [[Platform_Team/Sweets/1.0/Notes|notes]].
  
−
=== Doers ===
+
== Zero Install basis ==
  
−
Authors of code are always interested in supporting as large an audience of users as possible. And since people can use Sugar in different environments, it is critical to provide an instrument that permits an activity to run  on all Sugar platforms. In the case of Python-based activities, the existing practice of just zipping the activity code into .xo files works pretty well. But for arbitrary scripting languages, such as Ruby, that are not part of the [[0.88/Platform_Components|Sugar Platform]], for binary based activities and for activities that have dependencies that are not included in the Sugar Platform, there is the problem of providing the user with the necessary code.
+
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 [http://0install.net/injector-design.html design] page in particular.
  
−
Zero Sugar tries to solve all the possible issues that prevent activity launching in an heterogeneous Sugar environment.
+
== Further reading ==
  
−
Also, if you have some development idea in mind, you can start pushing it through the Sucrose release queue to get it into an upcoming (though maybe not the nearest) release. However, since the release process is binary—either your feature is included or not—Zero Sugar offers more flexibility for everyone. For example:
+
* [[Platform_Team/Sweets/Architecture|Sweets Architecture]] - A guide to basic Sweets concepts.
−
* some features are of arguable general benefit; Zero Sugar would allow interested end users to efficiently test (and even deploy) such features;
+
* [[Platform_Team/Guide/Sweets_Usage|Sweets Usage]] - A guide to know how to launch software using Sweets.
−
* some feature are only stable in limited environments; Zero Sugar would allow deployment in limited environments without the risk of destabilizing the rest of Sugar.
+
* [[Platform_Team/Guide/Sweets_Packaging|Sweets Packaging]] - A guide to know how to make your software accessible via Sweets.
 +
* [[Platform_Team/Infrastructure|Infrastructure Map]] - An overview of the Sweets software world.
  
−
=== Distributors ===
+
== Getting involved ==
  
−
The [[0.88/Platform_Components|Sugar Platform]] cannot grow endlessly, e.g., installing Sugar from packages should not fetch half of all available packages including several UI toolkits, several programming languages, etc. So, components like Qt or Ruby are (at least at present) not in the Sugar Platform list. But with Zero Sugar, activities could still use such dependencies by installing them from native packaging systems on demand, and without bundling their binaries.
+
* Read the [http://git.sugarlabs.org/sdk/sweets/blobs/master/HACKING HACKING] file to know how to contribute with code.
 +
{{:Platform_Team/Sweets/Feedback}}
  
−
== How it works at a glance ==
+
== Resources ==
  
−
Instruments and services that are used within Zero Sugar:
+
* [http://git.sugarlabs.org/sdk/sweets Sources].
−
* [[Activity Team/Zero Sugar/0sugar|0sugar]], the main tool, everything happens via the {{Code|0sugar}} command.
+
* Recipe files [[Platform_Team/Recipe_Specification|specification]].
−
* [http://0install.net/ 0install] decentralized deployment infrastructure.
 
−
* [http://build.opensuse.org/ OBS], openSUSE Build Service, build farms and repository of native packages for the GNU/Linux distributions and architectures that OBS [http://wiki.opensuse.org/openSUSE:Build_Service_supported_build_targets supports].
 
−
* [http://www.packagekit.org/ PackageKit] to install software from native packaging systems.
 
−
* [http://download.sugarlabs.org/ Sugar Labs]'s resources to host various files.
 
  
−
=== Identification ===
+
== Subpages ==
  
−
Every Zero Sugar package is identified by a Web url like [http://services.sugarlabs.org/gcompris GCompris]. The file, url points to, is regular 0install feed (in other words, 0install package) that contains metadata about package itself and all its implementations.
+
{{Special:PrefixIndex/{{PAGENAMEE}}/}}
−
 
 
−
Implementations are Web links to tarballs. Packages are split into implementations to:
 
−
* let user launch not only last version e.g. package can contain implementations for several branches or/and stabilities,
 
−
* split binary implementations per OS and platform,
 
−
* split implementations per language,
 
−
* support forks.
 
−
 
 
−
Zero Sugar natively supports ''forks'' (better name?) that could be [http://en.wikipedia.org/wiki/Fork_%28software_development%29 regular forks] or just results of doers' experiments i.e. without intension to push changes to an upstream. Forks are regular Zero packages and identified by unique Web url but linked to an upstream package (by mentioning upstream url in [http://0install.net/interface-spec.html#id4015759 feed-for] metadata field). So, having an upstream activity http://go.sugarlabs.org/Record, http://A.doer.org/My_Record from doer A and http://B.doer.org/My_Record from doer B, user C will have Record implementations from three sources.
 
−
 
 
−
Having urls as Zero packaging ids, it will be possible to:
 
−
* Launch activity in any supported environment just by passing activity url to {{Code|sugar-activity}} command.
 
−
* Shell's activities list items might not be tied to activity implementation. Useful for:
 
−
** creating activity catalogs without downloading implementations,
 
−
** more efficient disk-storage usage e.g remove less frequently used activities to save space for new ones.
 
−
 
 
−
=== Spec file ===
 
−
 
 
−
The process departing point is a [[Activity Team/Zero Sugar/0sugar.info Specification|spec file]] which is used within Zero Sugar to accomplish two major tasks:
 
−
 
 
−
* how to prepare the code to launch,
 
−
* how to share the code.
 
−
 
 
−
The Zero Sugar spec file is an all-sufficient entity. With only the spec file and tools like {{Code|0sugar}} and {{Code|0distro}}, it is possible to prepare the code necessary to launch in various environments like the major rpm/deb-based GNU/Linux distributions or just launch locally.
 
−
 
 
−
=== Prepare the code ===
 
−
 
 
−
The preparation step can be trivial, unless the code requires a building stage. Building might occur:
 
−
* on the developer's workstation, to deploy to environments similar to the developer's,
 
−
* on OBS, to build for the GNU/Linux distributions that OBS supports, or
 
−
* building might happen on the user's side, if other methods don't work.
 
−
 
 
−
=== Share the code ===
 
−
 
 
−
Sharing step might be:
 
−
* ''local'', if code needs to be run only in the doer's environment.<br>Zero Sugar spec file will be handled as a regular {{Code|activity.info}} file.
 
−
* ''peer-to-peer'', direct sharing between doer and users.
 
−
** Code can be launched if on-line users in the Neighborhood View have a copy of shared code, i.e., the doer only needs to be on-line to let other people launch his code.
 
−
** Just by transfering a bundle with the code, e.g., using .xo bundles.
 
−
* ''client-server'', doer needs to upload code to the server, and users will download it.<br>The particular method might be different:
 
−
** via the 0install infrastructure,
 
−
** via OBS repositories with native packages,
 
−
** by uploading bundles to servers like ASLO.
 
−
* ''distributor'', most likely similar to ''client-server'', but different from the doer's point of view, since only the distributor is responsible for a particular distribution method.
 
−
 
 
−
=== Regular workflow ===
 
−
 
 
−
The regular workflow within Zero Sugar, in the case of coding a Python-based activity, will look like the following:
 
−
 
 
−
* Create activity [[Activity_Team/Zero_Sugar/0sugar.info_Specification#Python_activity|spec file]].
 
−
* Code the activity.
 
−
* Try current code in Sugar just by selecting an icon in the activities list.
 
−
* When a milestone is achieved, call:
 
−
** {{Code|0sugar dist}} to create sources tarball
 
−
** {{Code|0sugar commit}} to let Sugar know that the activity can be shared in peer-to-peer mode between on-line users
 
−
* If doer wants to support server-client sharing model for a broad audience of users:
 
−
** choose the server to host 0install files (it could be [[Sysadmin/Shell_account_request|sunjammer.sugarlabs.org]] or any other server to rsync files to),
 
−
** call, {{Code|0sugar publish}} to publish 0install files
 
−
* If doer wants to support OBS based sugar distributions or users that prefer activities from native packages:
 
−
** create a project on OBS,
 
−
** call {{Code|0sugar push <obs-project>}}
 
−
* options for distributors:
 
−
** If it is an OBS-based distribution, there is no need for any packaging-related work at all, just link/branch the activity to your distribution project.
 
−
** Use the activity spec file and {{Code|0distro}} command to build native packages on non-OBS build farms. Most likely, the resulting packages will not conform to all the requirements for inclusion in an official repository, but this feature could still be useful when strong packaging rules are not required, e.g., in various Sugar/edu derivates like Trisquel-edu, SoaS or USR.
 
−
** Having a link to sources tarball on the page, package is identified by, and information about dependencies from the spec file, create a regular package for any particular GNU/Linux distribution.
 
−
 
 
−
== Documentation ==
 
−
 
 
−
Start your exploration of Zero Sugar beginning with these resources:
 
−
 
 
−
* How Zero Sugar looks from the Sugar Activity developer point of view
 
−
* How Zero Sugar looks from the 0install point of view
 
−
* How Zero Sugar [[Activity_Team/Zero_Sugar/Native_Packages|looks]] from the GNU/Linux distribution packaging point of view
 
−
 
 
−
See [[Activity Team/Zero Sugar/Packaging Guide|Packaging Guide]] for detailed instructions and Zero Sugar [[Activity Team/Zero Sugar/Use Cases|example use cases]] .
 
−
 
 
−
<!--
 
−
* [[Documentation Team/Services/Activity Developers Guide|Activity Developers Guide]] to get instructions on how to use the existing Zero Sugar packages in activities.
 
−
* [[Documentation Team/Services/Service Developers Guide|Service Developers Guide]] for how to create a Zero Sugar package.-->
 

Latest revision as of 14:51, 3 July 2012

Summary

Sweets is a Package Management System entirely 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 with these assumptions:

  • 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, viz., 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 goal is to create a new distribution method that goes beyond reusing the current methods:

  1. .xo bundles
    • Work smoothly only for pure python activities, though 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 simultaneous use of multiple versions of software, e.g., the results of experiments (the work) of different doers, in one environment. Users must manually handle the variety of activity versions, e.g., sort out all the local bundles or directories in ~/Activities.
  2. native packages
    • Are 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.

And, at the same time, the existing distribution methods are available for reuse in Sweets:

  1. .xo bundles are a subset of the Sweets workflow, from the usage point of view.
    • 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.

See also the initial release notes.

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.

Further reading

Getting involved

  • Read the HACKING file to know how to contribute with code.
  • Submit your bug report or feature request.
  • Subscribe to the sugar-devel mailing list and email with the subject prefixed with [SWEETS].
  • Ask your question on IRC channels, #sugar (not logged) or #sugar-newbies (logged).

Resources

Subpages

Retrieved from "https://wiki.sugarlabs.org/index.php?title=Platform_Team/Package_Management_System&oldid=80472"