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

From Sugar Labs
Jump to navigation Jump to search
m (link update)
 
(152 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<noinclude>{{GoogleTrans-en}}{{TOCright}}
 
[[Category:Activity Team]]
 
</noinclude>
 
 
 
== Summary ==
 
== Summary ==
  
Sugar Services provides transparency for users and convenience for activity developers across varying platforms (and their varying dependencies) as well as across Sugar releases. Sugar Services is a method to support this variety of activity dependencies and variety of dependency versions. In other words, Services is a common deployment system for activity dependencies; it is lightweight like [[Development_Team/Sugargame|sugargame]] and like Qt.
+
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.
 
 
The major difference from existed sugar deployment techniques is that Sugar Services has a point of view of the activity developer. It doesn't exclude (because it reuses them) Sucrose releases or GNU/Linux distribution initiatives, but it does give activity developers an additional (optional) instrument.
 
 
 
== Work flows ==
 
 
 
Sugar Services looks different depending upon your point of view:
 
 
 
=== Users ===
 
 
 
In the case of a poor Internet connection (and implemented [[Features/Zero_Install_integration|Zero Install integration]] feature), users can switch to offline mode and won't encounter any changes in their regular workflow. Switching to online mode brings additional progress bar to the launch dialog for activities that have pending/not-yet-downloaded/out-dated activity dependencies.
 
 
 
=== Activity developers ===
 
 
 
Sugar Services makes sense for activities that have non-Sugar Platform dependencies or support more then one Sucrose release cycle.
 
 
 
For such activities, development focus is shifted from Sucrose to an API of services they are using. More over, an activity could be assigned to particular service API version (provided that service developers still support this branch); Sugar Services will support several branches for the same service simultaneously.
 
 
 
To utilize the benefits of Services, activity developer need only to [[Activity Team/Documentation/Services/Activity Developers Guide|mention all services (or pure 0install feeds)]] that their activity is using. Services infrastructure will provide specified services (and specified versions) for the activity and will export environment variables, e.g., LD_LIBRARY_PATH or PYTHONPATH, to activity session. ''Activity developer need not to adapt their code to Services.''
 
 
 
=== Use of non-Sugar Platform dependencies in activities ===
 
 
 
The Sugar Platform cannot grow endlessly and components like Qt or OO4Kids are (at present) out of Sugar Platform list. But activities can still use such dependencies by installing them from native packaging systems without bundling binaries. See [[Activity_Team/Documentation/Services/Non_Sugar_Platform_Dependencies_Guide|Non Sugar Platform Dependencies Guide]] to know how to use 0install features.
 
 
 
=== Service developers ===
 
  
Services could be:
+
This new distribution method is initiated with these assumptions:
* libraries or applications that are not intended to be included to Sucrose
 
** could be used by few activities
 
** have shorter or longer release/support schedules
 
** just a useful way to share your library w/o bundling binary blobs
 
* dependencies that are specific to particular activity e.g. some python activities have C libraries, using Services, activity developer should not bundle all binaries that sugar supports but provide links to binaries that he managed to build and let Services build C libraries from sources on user side in the rest of cases
 
  
To create new service, developer needs to [[Activity Team/Documentation/Services/Service Developers Guide|create and share]] proper feed which could be used [[Activity Team/Documentation/Services/Activity Developers Guide|by activity developers]].
+
* The method to share software projects should to be as convenient as possible.
 +
* It is important to stimulate users into becoming doers&mdash;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&mdash;from software creators to software users.
  
=== Geeks ===
+
The goal is to create a new distribution method that goes beyond reusing the current methods:
  
The entirety of the Sugar Services feature is nothing but a Sugarized UI built around [http://0install.net/ 0install]; i.e., feed files that are being used in activity bundles are just regular 0install local feeds. Services could be used to install/upgrade any software (including sugar core components).
+
# [[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.
  
== What Sugar Services are not ==
+
And, at the same time, the existing distribution methods are available for reuse in Sweets:
  
* Sugar Services is not intended to cure all ills.
+
# [[Development_Team/Almanac/Activity_Bundles|''.xo bundles'']] are a subset of the Sweets workflow, from the usage point of view.
* It is not "must have" for activity developers; use it only if you really [[#Work_flows|need]] it.
+
#* It is possible to bundle an entire directory as a sweet project to use it as a regular .xo file.
* Is is not a replacement for GNU/Linux distributions packaging efforts; Sugar Services places no need for special treatment regarding dependencies as part of the [[0.86/Platform_Components|Sugar Platform]].
+
# ''native packages''
* It is not intended to be used to support large packages such as Qt that are not included in standard Sugar releases.  
+
#* 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.
  
Sugar Services works in parallel with distributions. With Sugar Services, it is possible (and preferable) to reuse native packages when they are available. Sugar Services provides a convenient way to install such packages and thus avert scenarios such as ''"That's really too bad that you don't have Firefox-3.5 in your three-year-old distribution and cannot run last Browse activity, but we cannot package Firefox-3.5 for you, so please update your distribution and Sugar Platform to last versions."''
+
See also the initial release [[Platform_Team/Sweets/1.0/Notes|notes]].
  
== Detailed Description ==
+
== Zero Install basis ==
  
This proposal assumes that the core of Sugar development (in common sense) is a wide variety of developers, not just those developers who are taking part in Sugar core (glucose) development. It is all about seeing Sugar activity development from an activity/3rd-party developer's point of view.
+
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.
  
From such new core POV, sugar development process will look like: <!-- not sure what you are trying to say here --Walter -->
+
== Further reading ==
* variety of Sugar activities
 
* that use Sugar Services
 
  
Developers use a set of services that have their own API changes based schedules. Existed glucose packages will be treated as a big service (split to several components, but thats not a task for this proposal). This proposal is about proposing basic infrastructure of Sugar Services and several services that are not part of glucose.
+
* [[Platform_Team/Sweets/Architecture|Sweets Architecture]] - A guide to basic Sweets concepts.
 +
* [[Platform_Team/Guide/Sweets_Usage|Sweets Usage]] - A guide to know how to launch software using Sweets.
 +
* [[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.
  
The corner stone of Sugar Services proposal is [[Activity_Team/Services/Saccharin|Saccharin]] service. This service provides installing/upgrading (via 0install) mechanism for all other services. The rest of services is just variety of libraries/applications.
+
== Getting involved ==
  
Technically, Sugar Services could be a part of glucose (or some of its releases) but from activity POV it doesn't make much sense. If an activity requires some service, [[Activity_Team/Services/Saccharin|Saccharin]] will do nothing if requested service/version is already a part of the installed glucose or install proper service(via 0install). Various activities on the same system could use various versions of the same service, in that case [[Activity_Team/Services/Saccharin|Saccharin]](via 0install) will just provide proper version to particular activity.
+
* Read the [http://git.sugarlabs.org/sdk/sweets/blobs/master/HACKING HACKING] file to know how to contribute with code.
 +
{{:Platform_Team/Sweets/Feedback}}
  
== List of services ==
+
== Resources ==
  
{{Special:PrefixIndex/{{PAGENAME}}/}}
+
* [http://git.sugarlabs.org/sdk/sweets Sources].
 +
* Recipe files [[Platform_Team/Recipe_Specification|specification]].
  
== Documentation ==
+
== Subpages ==
  
{{Special:PrefixIndex/Documentation_Team/Services/}}
+
{{Special:PrefixIndex/{{PAGENAMEE}}/}}

Latest revision as of 15: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