Sugar Labs - User contributions [en]

Gsoc-2018-cross-version-python-support

2020-10-30T21:31:38Z

Pro-panda: Pro-panda moved page Gsoc-2018-cross-version-python-support to User:Pro-panda:gsoc-project

#REDIRECT [[User:Pro-panda:gsoc-project]]

User:Pro-panda:gsoc-project

2020-10-30T21:31:38Z

Pro-panda: Pro-panda moved page Gsoc-2018-cross-version-python-support to User:Pro-panda:gsoc-project

User:Pro-panda:gsoc-project

2020-10-30T21:30:56Z

Pro-panda: Blanked the page

User:Pro-panda/GSoC 2018 Project

2020-10-30T21:28:57Z

Pro-panda: Pro-panda moved page User:Pro-panda/GSoC 2018 Project to Gsoc-2018-cross-version-python-support

#REDIRECT [[Gsoc-2018-cross-version-python-support]]

User:Pro-panda:gsoc-project

2020-10-30T21:28:57Z

Pro-panda: Pro-panda moved page User:Pro-panda/GSoC 2018 Project to Gsoc-2018-cross-version-python-support

=== Project details ===
Implement Cross Version Python Support for Sugar
Project summary and progress can be seen https://wiki.sugarlabs.org/go/Python_2to3

=== Work Completed ===
Pro-Panda's overall code contribution can be found [https://github.com/search?l=&o=desc&q=org%3Asugarlabs++author%3APro-Panda&s=&type=Issues here].

==== Summary of my work GSoC work: ====
* Port Sugar Artwork to Python 3
* Port Sugar Toolkit to six
* Port Sugar Datastore to Python 3
* Port Sugar to Python 3 [WIP to some extent]
* Make Debian Packages for the core components
* Port 20 activities to Python 3, complete almost the entire fructose set
* Port Telepathy Bindings for 9 activities
* Port smaller components like sugargame, sugar-iconify, etc
* Make corresponding relevant changes in the documentation
* Working on general issues of improving activities or the core modules; outside of the GSoC Project
* Reviewing, Testing and merging Pull requests; outside of the GSoC Project

User:Pro-panda:gsoc-project

2020-10-27T17:00:15Z

Pro-panda:

User:Pro-panda

2020-10-27T16:58:53Z

Pro-panda: Blanked the page

Oversight Board/2019-2021-candidates/Rahul Bothra

2020-01-05T11:44:32Z

Pro-panda:

= Rahul Bothra =

== Bio ==
I work as a full time Software Engineer, working on products enabling enterprise cloud services. I try to volunteer my time for Sugar Labs, although I haven't been much active recently. I originally started working with Sugar Labs as a Student Developer with the GSoC program.

; Motivation
I perceive Sugar Labs' mission as part of a larger cause I'm inclined towards - to make learning tools more accessible to everyone. I'm happy that the tools we build serve this purpose, although our recent work on Sugar is not improving lives, if at all reaching its users.

; Code
https://github.com/search?q=org%3Asugarlabs+author%3Apro-panda

== Goals ==
The goals are borrowed and edited from what James Cameron suggested in his agenda for SLOB elections in 2018. I intend to abide by these,
* we will continue to maintain Sugar and the activities,
* we will forego or remove any unused mailing lists, committees, boards or offices, in order to improve our collaboration,
* we will reduce the resources spent on other software such as web site, social media, or infrastructure for developers, as these are either mostly static or provided for free by others,
* we will require new members to have made a non-trivial and accepted contribution to the Software,

== Contact ==
Email: rrbothra [at] gmail [dot] com

Oversight Board/2019-2021-candidates/Rahul Bothra

2020-01-04T14:15:37Z

Pro-panda:

= Rahul Bothra =

== Bio ==
I work as a full time Software Engineer, working on products enabling enterprise cloud services. I try to volunteer my time for Sugar Labs, although I haven't been much active recently. I originally started working with Sugar Labs as a Student Developer with the GSoC program.

; Motivation
I perceive Sugar Labs' mission as part of a larger cause I'm inclined towards - to make learning tools more accessible to everyone. I'm happy that the tools we build serve this purpose, although our recent work on Sugar is not improving lives, if at all reaching its users.

; Code
https://github.com/search?q=org%3Asugarlabs+author%3Apro-panda

== Goals ==
The goals are borrowed and edited from what James Cameron suggested in his agenda for SLOB elections in 2018. I intend abide by these,
* we will continue to maintain Sugar and the activities,
* we will forego or remove any unused mailing lists, committees, boards or offices, in order to improve our collaboration,
* we will reduce the resources spent on other software such as web site, social media, or infrastructure for developers, as these are either mostly static or provided for free by others,
* we will require new members to have made a non-trivial and accepted contribution to the Software,

== Contact ==
Email: rrbothra [at] gmail [dot] com

Oversight Board/2019-2021-candidates/Rahul Bothra

2020-01-04T11:25:05Z

Pro-panda: Created page with "= Rahul Bothra = == Bio == I work as a full time Software Engineer, working on products enabling enterprise cloud services. I try to volunteer my time for Sugar Labs, althoug..."

= Rahul Bothra =

== Bio ==
I work as a full time Software Engineer, working on products enabling enterprise cloud services. I try to volunteer my time for Sugar Labs, although I haven't been much active recently. I originally started working with Sugar Labs as a Student Developer with the GSoC program in 2018. I was a mentor in GSoC and GCI 2018. I also acted as a liason to Google for GSoC 2018 with Walter Bender and James Cameron.

; Motivation
I perceive Sugar Labs' mission as part of a larger cause I'm inclined towards - to make learning tools more accessible to everyone. I'm happy that the tools we build serve this purpose, although our recent work on Sugar is not reaching improving lives, if at all reaching users.

; Code
https://github.com/search?q=org%3Asugarlabs+author%3Apro-panda

== Goals ==
The goals are borrowed and edited from what James Cameron suggested in his agenda for SLOB elections in 2018. I intend abide by these,
* we will continue to maintain Sugar and the activities,
* we will forego or remove any unused mailing lists, committees, boards or offices, in order to improve our collaboration,
* we will reduce the resources spent on other software such as web site, social media, or infrastructure for developers, as these are either mostly static or provided for free by others,
* we will require new members to have made a non-trivial and accepted contribution to the Software,

== Contact ==
Email: rrbothra [at] gmail [dot] com

Vacancies

2019-03-18T14:36:13Z

Pro-panda: Blanked the page

Sugar Labs/Getting Involved

2019-03-18T14:20:24Z

Pro-panda: /* Join Sugar Labs */

<noinclude>{{Translations | [[Sugar_Labs/Getting_Involved|english]] | [[Sugar_Labs/Getting_Involved/lang-es|español]]}}{{TeamHeader|Sugar Labs|home=Community Home|meeting_link=Events|meeting_label=Events Calendar}}</noinclude>
__FORCETOC__
'''We need your help in improving how computers are used in education'''. ''You'' can take an active hand in making Sugar realize its [[Archive/Current_Events/2009-03-17#What_are_our_objectives.3F | '''vision''']]. Making [[What is Sugar?|'''Sugar''']] depends on volunteers who love to engage in authentic activities—activities that help fulfill the potentials they individually see in Sugar's vision. What do you want to see happen? What roles could you fill? Click the role of your choice in the grid below, and then, after selecting a Team or project link, follow the '''Join''' links at the top of the Team or project page (in the green or yellow linkbar) to learn how you can '''Join In'''. We depend on ''you'' getting involved!
Apply for membership [[Sugar_Labs/Members|here]].

<div class="noborder">
{| class="wikitable" cellspacing="0" cellpadding="5" width=100% style="background:#eeeeff;border:5px solid white;text-align:center;"
|-
|valign="TOP" width=33% style="border:5px solid white;"|[[File:Join_Educator.png|link=#Educator]]

[[#Educator | Educator]]

|valign="TOP" width=33% style="border:5px solid white;" |[[File:Join_ContentDeveloper.png|link=#Content Writer]]

[[#Content_Writer | Content Writer]]

|valign="TOP" width=33% style="border:5px solid white;"|[[File:Join_PeoplePerson.png|link=#People Person]]

[[#People_Person | People Person]]
|-
|valign="TOP" width=33% style="border:5px solid white;"|[[File:Join_Developer.png|link=#Developer]]

[[#Developer | Developer]]

|valign="TOP" width=33% style="border:5px solid white;"|[[File:Join_Designer.png|link=#Designer]]

[[#Designer | Designer]]

|valign="TOP" width=33% style="border:5px solid white;"|[[File:Join_Translator.png|link=#Translator]]

[[#Translator | Translator]]
|-
|valign="TOP" colspan="3" style="border:5px solid white;"|
'''[[What could I do in an hour?]]'''
|-
|valign="TOP" colspan="3" style="border:5px solid white;"|
Financial contributions are discussed on the [[Sugar Labs/Donate]] page.
|}
</div>

====Learn more====

Help us understand and improve the ability for people to contribute and become deeply involved with Sugar.
{{Iframe|See [http://planet.sugarlabs.org Planet Sugar Labs], our blog aggregator |http://planet.sugarlabs.org|900|600|1}}
* Sugar Labs [[Sugar Labs/Communication channels|Communication channels]], [[:Category:Participate |Participation pages]], [[Sugar Labs/Volunteer Funnel|Volunteer Funnel]], & [[Vacancies]],
* The One Laptop per Child [[olpc:Participate | Participation page]].
<div style="background-color:#a0ff93; border:1px solid #cdf; padding:6px 14px;">
The Sugar community is made of individuals, teams, and relationships.

We all share one thing in common: '''We want to improve how computers are used in education'''.

Join us in discussing the project on the [http://lists.sugarlabs.org/listinfo/iaep It's an Education Project] mailing list. [http://wiki.sugarlabs.org/index.php?title=Special:OpenIDLogin&returnto=Special:UserLogin Open a wiki account here] and edit this site.
</div>

{{Anchor | Educator}}

== Educator ==
[[Image:Join_Educator_BW.png|link=]]

'''Description of this role:''' Focus on Sugar's learners educational needs.

'''Skills you possess or want to learn''':
* Explaining complex ideas well, people skills, teaching through digital media, understanding of educational theories and obstacles, paedagogy, ability to communicate with and influence developers.

'''Teams/projects associated with this role''':
* | [[Education Team]] | [[Activity Team]] | [[Deployment Team]] | [[Local Labs]] |
* | [[Math4Team]] | [[Sugar on a Stick]] | [[Replacing Textbooks]]

'''Tasks typical in this role''':
* Tasks typical in this role: Lesson plans, teacher guides, text book templates/samples, articles, leverage Sugar as an ideal platform for learning, provide guidance and feedback to those working on technical aspects of Sugar, setting educational goals, educational activities.

'''Real person to help you get started''':
* If you are an educator who would like to help with Sugar, please subscribe and contact [http://lists.sugarlabs.org/listinfo/iaep iaep] at sugarlabs dot org. iaep it's an acronym of "It's an Education Project" and it is the main emails list supported by Sugar labs Systems team. IAEP helps Educators, learners, designers and programmers interact while learning the how to's to develop and sharing of their projects.

{{Anchor|ContentWriter}}

== Content Writer ==
[[Image:Join_ContentDeveloper_BW.png|link=]]

'''Description of this role:''' Communicate through words.

'''Skills you possess or want to learn''':
* Writing, editing, grammar, wordsmithing, proof-reading, explaining complex ideas well, teaching, wiki markup, technical knowledge (specific and general).
'''Teams associated with this role''':
* | [[Documentation Team]] | [[Marketing Team]] | [[Wiki Team]] | [[Deployment Team]] | [[Local Labs]] |
* | [[Math4Team]] | [[Replacing Textbooks]]
'''Tasks typical in this role''':
* Write, edit, illustrate, or program an Open Education Resource on any subject for any age in the Sugar Labs [[Replace Textbooks]] project.
* Write a [http://booki.flossmanuals.net FLOSS Manual] for your favorite activity, guides, how-tos, FAQs, knowledge base, lesson plans, teacher guides, text book templates/samples, articles, marketing material, process/methodology documents, editing, release notes.
'''Real person to help you get started''':
* If you are a content writer please subscribe and contact [http://lists.sugarlabs.org/listinfo/iaep iaep] at sugarlabs dot org. iaep it's an acronym of "It's an Education Project" and it is the main emails list supported by Sugar labs Systems team. IAEP helps Educators, learners, designers and programmers interact while learning the how to's to develop and sharing of their projects.

{{Anchor|PeoplePerson}}

== People Person ==
[[Image:Join_PeoplePerson_BW.png|link=]]

'''Description of this role:''' Communicate through one-on-one contact.

'''Skills you possess or want to learn''':
* People skills, public relations, event organization, customer service/support, enthusiasm.

'''Teams/projects associated with this role''':
* | [[Marketing Team]] | [[Documentation Team]] | [[Deployment Team]] | [[Local Labs]] |
* | [[Sugar on a Stick]] |

'''Tasks typical in this role''':
* Conferences, press releases, local events, organizing events, community management, Sugar Labs forum/IRC help/support tech, send out media/spread Sugar, encourage others to participate, cat herding.

'''Real person to help you get started''':
* If you are a people person who would like to help with Sugar Labs Project Management, please contact slobs at sugarlabs dot org.

{{Anchor|Developer}}

== Developer ==
[[Image:Join_Developer_BW.png|link=]]

'''Description of this role:''' Communicate through code.

'''Skills you possess or want to learn''':
* Python, C, GTK+, git, packaging, bug filing, tracking and testing, JavaScript, web app development, GNU/Linux system administration

'''Teams/projects associated with this role''':
* See https://github.com/sugarlabs/sugar-docs for the most current information.
* | [[Development Team]] | [[Activity Team]] | [[Platform Team]] | [[BugSquad|Testing Team]] | [[Infrastructure Team]] |
* | [[Summer of Code | Google Summer of Code]] | [[Math4Team]] | [[Development Team/Project Ideas | Project Ideas]] | [[Sugar on a Stick]] |

'''Tasks typical in this role''':
* Get the source code, test & break Sugar, design & build Sugar, file bugs, fix bugs, build packages, develop new features, test, design, develop & help maintain activities, toolchain, scripts.

'''Real people to help you get started''':
* [[Mentors]]
* If you are a developer who would like to help with Sugar, please introduce yourself at the [http://lists.sugarlabs.org/listinfo/sugar-devel sugar devel mailing list]

{{Anchor|Designer}}

== Designer ==
[[Image:Join_Designer_BW.png|link=]]

'''Description of this role:''' Communicate through images.

'''Skills you possess or want to learn''':
* Inkscape, GIMP, other vector & raster graphics tools, OpenOffice, design, usability/interaction.

'''Teams/projects associated with this role''':
* | [[Design Team|Design Team]] | [[Marketing Team]] | [[Documentation Team]] |
* | [[Math4Team]] |

'''Tasks typical in this role''':
* Sugar art work (SVG activity icons, toolbar icons), Activity image content, user interface design, publication design, web design, icons, design mock-ups, conference banners/flyers, logos, materials (t-shirts, CD covers, etc.)

'''Real person to help you get started''':
* If you are a designer who would like to help with Sugar, please subscribe and contact [http://lists.sugarlabs.org/listinfo/iaep iaep] at sugarlabs dot org. iaep it's an acronym of "It's an Education Project" and it is the main emails list supported by Sugar labs Systems team. IAEP helps Educators, learners, designers and programmers interact while learning the how to's to develop and sharing of their projects.

== Translator ==
[[Image:Join_Translator_BW.png|link=]]

'''Description of this role:''' Communicate through interpretation.

'''Skills you possess or want to learn''':
* English, Non-English native language, technical knowledge, Pootle, PO, translation.

'''Teams/projects associated with this role''':
* | [[Translation Team]] | [[Documentation Team]] | [[Wiki Team | Wiki Team]] | [[Local Labs]] | [[Replacing Textbooks]]
'''Tasks typical in this role''':
* Activity and Sugar user interface string translation, localization (l10n), internationalization (i18n), marketing materials, documents, OERs, websites, providing cultural specific feedback to other teams.
* '''Real person to help you get started''': If you are a translator who would like to help with translating Sugar, please contact translate at sugarlabs dot org.

[[Category:Participate]]

Outreachy

2019-03-17T17:47:17Z

Pro-panda: Replaced content with "Sugar Labs is currently not participating in the Outreachy Programme"

Sugar Labs is currently not participating in the Outreachy Programme

Outreachy

2019-01-04T09:50:37Z

Pro-panda: Remove GSoC 2017 details from outreachy page

This page contains information specific to the May 30 to August 30, 2017 round of [https://www.gnome.org/outreachy/ Outreachy] internships.

== About Sugar Labs ==

At Sugar Labs, we make tools that learners use to explore, discover, create, and reflect. We encourage our users to appropriate them, taking ownership and responsibility for their learning.

Sugar Labs, a volunteer-driven, non-profit organization, had its origins in the One Laptop Per Child project and is has been a member project of the Software Freedom Conservancy since 2008.

Sugar is both a desktop and a collection of Activities. Activities, as the name implies, are Apps that involve active engagement from the learner. Activities automatically save results to a journal, where reflections are recorded. Activity instances can be shared between learners; many support real-time collaboration.

* Sugar facilitates sharing and collaboration: Children can write, share books, or make music together with a single mouse-click.
* Activities, not applications: Sugar activities are applicable beyond the scope of the classroom and even Sugar itself.
* Automatic backup of Activity work; no worrying about files or folders. Sugar’s Journal makes it almost impossible to lose any data.
* The Sugar Journal records everything you do: It is a place to reflect upon and evaluate your work.
* Sugar runs on most computer hardware, including slower machines.
* Sugar is Free (Libre) Software: It is written in the Python language and easily customized.
* Sugar is documented by its users: It is easy to use and teachers worldwide have created a wealth of pedagogical materials for it.
* Sugar is largely written and maintained by its users.
* Sugarizer is a fork of Sugar available for tablets and phones.

Our primary FOSS License is GNU General Public License version 3.0 (GPL-3.0).

=== About Our Community ===

As mentioned above, our community is composed 100% by volunteers. May (most) of are contributors are youth who use (of have used) Sugar in school. We have participated in Google Code-in and Google Summer of Code for many years, which have also been a source of contributions to the project.

Our community members span the globe—and while we have never had a commit from Antarctica, Sugar has been used on every continent. Contributors bring many skills: Python and JavaScript programming; graphic design; marketing and communication; documentation; user-interface design; game design; pedagogy; research into best practices; and, perhaps most important, using Sugar as a tool for learning.

Our mentors are:

* walter AT sugarlabs DOT com
* devin AT devinulibarri DOT com

=== Getting Started ===

These days there are a number of different paths to getting started with Sugar. You can:
* follow the instructions for setting up our developer environment [https://developer.sugarlabs.org/];
* try Sugarizer [http://sugarizer.org/]; or
* explore some of our stand-alone activities such as Music Blocks [http://walterbender.github.io/musicblocks/].

We have lots of open issues in our various GitHub repositories: [https://github.com/sugarlabs] and [https://github.com/walterbender/musicblocks], some of which involve some coding, but many of which involve testing and documentation.

== About Outreachy ==

=== Sponsors ===
Outreachy is hosted by [https://sfconservancy.org Software Freedom Conservancy] with the special support from [https://www.redhat.com Red Hat] and the [https://www.gnome.org/foundation/ GNOME Foundation].

=== Schedule ===

;February 16:participating organizations are announced and application system opens
;February 16 - March 30: applicants need to get in touch with at least one project and make a contribution to it
;March 30: application deadline at 4pm UTC
;March 30 - April 28: applicants are encouraged to continue making contributions for the project they applied for; submitted applications are open for editing
;April 28: accepted participants announced on this page at 4pm UTC
;May 30 - August 30: internship period

=== Payments Schedule ===
Please refer to [https://wiki.gnome.org/Outreachy/2017/MayAugust] for details about how the SFC administers payments for the program.

Summer of Code

2018-12-25T19:10:27Z

Pro-panda: Replaced content with "Moved to https://github.com/sugarlabs/GSoC"

Moved to https://github.com/sugarlabs/GSoC

Welcome to the Sugar Labs wiki

2018-12-25T10:29:08Z

Pro-panda:

__NOEDITSECTION__
__NOTOC__

{| border="0" 
|- row1
|[[File:Download_Mirabell.png|center|link=Downloads]] [[Image:Sugarlabs_mainpage_01.png|link=Sugar Labs/Getting Involved]]
| 
;First time visit?: Please take a look around our wiki and our [http://github.com/sugarlabs GitHub Page]
;Software Developer?: Check out our developer documentation on Github, https://github.com/sugarlabs/sugar-docs
;Google Summer of Code?: Go through our guide for GSoC, https://github.com/sugarlabs/GSoC

;Want to help?: Welcome to the Sugar Labs community! We are contributors of all types - teachers, writers, coders, designers, testers, and more - who work together from around the world on Sugar. Visit the '''[[Sugar Labs/Getting Involved | Getting Involved]]''' page, and find out how you can join in the fun of learning. We have some [[Vacancies]] and are always looking for maintainers and testers.

;Using Sugar?: Get Activities from http://activities.sugarlabs.org

|- row2

|}

<div style="background:#c8edff;border:1px solid #cdf; word-spacing:15px; padding: 0px 5px; font-size:100%; text-align:center" class="linkgroup">
'''[[Sugar Labs/Current Events | News]] [[Sugar Labs/Getting Involved | Join]] [[Downloads]] [[Sugar Labs/Contacts | Contact]] [[Sugar Labs | About Us]]'''
</div>

=== Community News ===

''[[Trademark|Sugar Labs®]] is a member project of the [http://www.sfconservancy.org/ Software Freedom Conservancy], a USA 501(c)(3) not-for-profit organization, and is supported by our generous [[Sugar Labs/Getting Involved|contributors]] and [[Sugar Labs/Thank You|sponsors]].''

<noinclude>
{{Translations | [[Welcome to the Sugar Labs wiki|english]] | [[Welcome to the Sugar Labs wiki/lang-es|español]] | [[Welcome to the Sugar Labs wiki/lang-pt_BR|português brasil]] | [[Welcome to the Sugar Labs wiki/lang-ps|پښتو]] | [[Welcome to the Sugar Labs wiki/lang-ru_RU|русский]]}}
</noinclude>

Welcome to the Sugar Labs wiki

2018-12-18T07:39:48Z

Pro-panda: update first time guide

__NOEDITSECTION__
__NOTOC__

{| border="0" 
|- row1
|[[File:Download_Mirabell.png|center|link=Downloads]] [[Image:Sugarlabs_mainpage_01.png|link=Sugar Labs/Getting Involved]]
| 
;First time visit?: Please take a look around our wiki and our [http://github.com/sugarlabs GitHub Page]
;Want to help?: Welcome to the Sugar Labs community! We are contributors of all types - teachers, writers, coders, designers, testers, and more - who work together from around the world on Sugar. Visit the '''[[Sugar Labs/Getting Involved | Getting Involved]]''' page, and find out how you can join in the fun of learning. We have some [[Vacancies]] and are always looking for maintainers and testers.

;Using Sugar?: Get Activities from http://activities.sugarlabs.org

;Software Developer?: Check out our developer documentation on Github, https://github.com/sugarlabs/sugar-docs

|- row2

|}

<div style="background:#c8edff;border:1px solid #cdf; word-spacing:15px; padding: 0px 5px; font-size:100%; text-align:center" class="linkgroup">
'''[[Sugar Labs/Current Events | News]] [[Sugar Labs/Getting Involved | Join]] [[Downloads]] [[Sugar Labs/Contacts | Contact]] [[Sugar Labs | About Us]]'''
</div>

=== Community News ===

Sugar Labs is participating in Google Summer of Code 2018. Please see [[Summer_of_Code/2018]] for details.

''[[Trademark|Sugar Labs®]] is a member project of the [http://www.sfconservancy.org/ Software Freedom Conservancy], a USA 501(c)(3) not-for-profit organization, and is supported by our generous [[Sugar Labs/Getting Involved|contributors]] and [[Sugar Labs/Thank You|sponsors]].''

<noinclude>
{{Translations | [[Welcome to the Sugar Labs wiki|english]] | [[Welcome to the Sugar Labs wiki/lang-es|español]] | [[Welcome to the Sugar Labs wiki/lang-pt_BR|português brasil]] | [[Welcome to the Sugar Labs wiki/lang-ps|پښتو]] | [[Welcome to the Sugar Labs wiki/lang-ru_RU|русский]]}}
</noinclude>

Welcome to the Sugar Labs wiki

2018-12-18T07:35:26Z

Pro-panda: Remove sugar digest from home - outdated

__NOEDITSECTION__
__NOTOC__

{| border="0" 
|- row1
|[[File:Download_Mirabell.png|center|link=Downloads]] [[Image:Sugarlabs_mainpage_01.png|link=Sugar Labs/Getting Involved]]
| 
;First time visit?: Please take a look around our wiki. Explore the menus along the left side of the page. If you ever get lost, just click on the logo at the top left of every page and you will return to this page. See [[Wiki_Team/Resources#Sugar_Labs_Wiki_Guide|this guide]] for help with wiki editing, and check out the [[Getting Started]] page!

;Want to help?: Welcome to the Sugar Labs community! We are contributors of all types - teachers, writers, coders, designers, testers, and more - who work together from around the world on Sugar. Visit the '''[[Sugar Labs/Getting Involved | Getting Involved]]''' page, and find out how you can join in the fun of learning. We have some [[Vacancies]] and are always looking for maintainers and testers.

;Using Sugar?: Get more Activities from http://activities.sugarlabs.org

;Software Developer?: Check out our developer documentation on Github, https://github.com/sugarlabs/sugar-docs

|- row2

|}

<div style="background:#c8edff;border:1px solid #cdf; word-spacing:15px; padding: 0px 5px; font-size:100%; text-align:center" class="linkgroup">
'''[[Sugar Labs/Current Events | News]] [[Sugar Labs/Getting Involved | Join]] [[Downloads]] [[Sugar Labs/Contacts | Contact]] [[Sugar Labs | About Us]]'''
</div>

=== Community News ===

Sugar Labs is participating in Google Summer of Code 2018. Please see [[Summer_of_Code/2018]] for details.

We've also archived all our Press Releases at http://www.sugarlabs.org/press and the [[News]] previously posted on this front page.

''[[Trademark|Sugar Labs®]] is a member project of the [http://www.sfconservancy.org/ Software Freedom Conservancy], a USA 501(c)(3) not-for-profit organization, and is supported by our generous [[Sugar Labs/Getting Involved|contributors]] and [[Sugar Labs/Thank You|sponsors]].''

<noinclude>
{{Translations | [[Welcome to the Sugar Labs wiki|english]] | [[Welcome to the Sugar Labs wiki/lang-es|español]] | [[Welcome to the Sugar Labs wiki/lang-pt_BR|português brasil]] | [[Welcome to the Sugar Labs wiki/lang-ps|پښتو]] | [[Welcome to the Sugar Labs wiki/lang-ru_RU|русский]]}}
</noinclude>

Oversight Board/2018-2020-candidates/Rahul Bothra

2018-11-30T05:11:31Z

Pro-panda:

Hi everyone,
I am Rahul Bothra (pro-panda).

'''My contributions,'''
* [https://github.com/search?q=org%3Asugarlabs+author%3Apro-panda Active code contributor]; also working on [https://summerofcode.withgoogle.com/archive/2018/projects/5320748025511936/ Port to Python 3] project
* [http://lists.sugarlabs.org/archive/sugar-devel/2018-February/055080.html Code reviewer] and activity maintainer
* GSoC' 18 student and GCI' 18 mentor

I am excited by our goals and our potential, but I am also concerned that we are functioning in an inefficient manner.

'''Currently in the SLOB meetings,'''
* A lot of the members are inactive. They don't attend the SLOB meetings or reply to motions, crippling our progress.
* We don't have a concrete plan of our goals. We try to cover a lot of breath in our efforts, and end up working on things which are not related to our goals (eg: Sugar Social)
* We drag work for a lot of time, (eg: ASLO v3) a direct result of inactive mentoring and checks during GSoC
* Lack of concern about the number of developers working on Sugar and its activities. We are failing in attracting new consistent developers for it, despite being a popular organisation in the Google programs.
* The selection of mentors and organisation admins for Google programs is a closed process.

'''What I will undertake once elected:'''
* Attend every SLOB meeting regularly
* Revamping how we conduct GCI and GSoC to attract more contributions as well as improve the quality of mentoring; making sure we prioritise tasks which are more important to us, adding more checks before adding developers, grooming of every task / project before it is added / selected.
* Make a clear roadmap of our goals for the next 2 years in each domain of code, outreach, design and content. Start towards implementation of those goals according to priority.
* Make sure everything (except any decision concerning only the board) are taken publicly and in an open environment

Oversight Board/2018-2020-candidates/Rahul Bothra

2018-11-30T05:08:41Z

Pro-panda:

Hi everyone,
I am Rahul Bothra (pro-panda).

'''My contributions,'''
* [https://github.com/search?q=org%3Asugarlabs+author%3Apro-panda Active code contributor]
* Activity Maintainer for Flappy and CowBulls
* [http://lists.sugarlabs.org/archive/sugar-devel/2018-February/055080.html code reviewer].
* GSoC' 18 student working on [https://summerofcode.withgoogle.com/archive/2018/projects/5320748025511936/ porting Sugar to Python 3].
* GCI' 18 mentor

I am excited by our goals and our potential, but I am also concerned that we are functioning in an inefficient manner.

'''Currently in the SLOB meetings,'''
* A lot of the members are inactive. They don't attend the SLOB meetings or reply to motions, crippling our progress.
* We don't have a concrete plan of our goals. We try to cover a lot of breath in our efforts, and end up working on things which are not related to our goals (eg: Sugar Social)
* We drag work for a lot of time, (eg: ASLO v3) a direct result of inactive mentoring and checks during GSoC
* Lack of concern about the number of developers working on Sugar and its activities. We are failing in attracting new consistent developers for it, despite being a popular organisation in the Google programs.
* The selection of mentors and organisation admins for Google programs is a closed process.

'''What I will undertake once elected:'''
* Attend every SLOB meeting regularly
* Revamping how we conduct GCI and GSoC to attract more contributions as well as improve the quality of mentoring; making sure we prioritise tasks which are more important to us, adding more checks before adding developers, grooming of every task / project before it is added / selected.
* Make a clear roadmap of our goals for the next 2 years in each domain of code, outreach, design and content. Start towards implementation of those goals according to priority.
* Make sure everything (except any decision concerning only the board) are taken publicly and in an open environment

Oversight Board/2018-2020-candidates/Rahul Bothra

2018-11-30T05:02:08Z

Pro-panda:

Hi everyone,
I am Rahul Bothra (pro-panda). I am a Python Developer and [http://lists.sugarlabs.org/archive/sugar-devel/2018-February/055080.html code reviewer] for Sugar Labs.

I was a GSoC' 18 student with Sugar Labs, and I worked on [https://summerofcode.withgoogle.com/archive/2018/projects/5320748025511936/ porting Sugar to Python 3]. I continue contributing in terms of code, code reviews and as a mentor in GCI' 18.

I am excited by our goals and our potential, but I am also concerned that we are functioning in an inefficient manner.

'''Currently in the SLOB meetings,'''
* A lot of the members are inactive. They don't attend the SLOB meetings or reply to motions, crippling our progress.
* We don't have a concrete plan of our goals. We try to cover a lot of breath in our efforts, and end up working on things which are not related to our goals (eg: Sugar Social)
* We drag work for a lot of time, (eg: ASLO v3) a direct result of inactive mentoring and checks during GSoC
* Lack of concern about the number of developers working on Sugar and its activities. We are failing in attracting new consistent developers for it, despite being a popular organisation in the Google programs.
* The selection of mentors and organisation admins for Google programs is a closed process.

'''What I will undertake once elected:'''
* Attend every SLOB meeting regularly
* Revamping how we conduct GCI and GSoC to attract more contributions as well as improve the quality of mentoring; making sure we prioritise tasks which are more important to us, adding more checks before adding developers, grooming of every task / project before it is added / selected.
* Make a clear roadmap of our goals for the next 2 years in each domain of code, outreach, design and content. Start towards implementation of those goals according to priority.
* Make sure everything (except any decision concerning only the board) are taken publicly and in an open environment

Oversight Board/2018-2020-candidates/Rahul Bothra

2018-11-30T05:01:40Z

Pro-panda:

Oversight Board/2018-2020-candidates/Rahul Bothra

2018-11-30T02:26:04Z

Pro-panda:

Hi everyone,
I am Rahul Bothra (pro-panda). I am a Python Developer and [http://lists.sugarlabs.org/archive/sugar-devel/2018-February/055080.html code reviewer] for Sugar Labs.

I was a GSoC' 18 student with Sugar Labs, and I worked on [https://summerofcode.withgoogle.com/archive/2018/projects/5320748025511936/ porting Sugar to Python 3]. I continue contributing in terms of code, code reviews and as a mentor in GCI' 18.

I am excited by our goals and our potential. But I am concerned that the way we are working is wrong.

'''Currently in the SLOB meetings,'''
* A lot of the members are inactive. They don't attend the SLOB meetings or reply to motions, crippling our progress.
* There is a lot of talk, but there is not an equivalent amount of work done. We fail to properly materialise discussions
* We don't have a concrete plan of our goals. We try to cover a lot of breath in our efforts, and end up working on things which are not related to our goals (eg: Sugar Social)
* We drag work for a lot of time, (eg: ASLO v3) a direct result of inactive mentoring and checks during GSoC
* Lack of concern about the number of developers working on Sugar and its activities. We are failing in attracting new consistent developers for it, despite being a popular GSoC and GCI organisation.

'''What I will undertake once elected:'''
* Attend every SLOB meeting regularly
* Revamping how we conduct GCI and GSoC to attract more contributions as well as improve the quality of mentoring; making sure we prioritise tasks which are more important to us, adding more checks before adding developers, grooming of every task / project before it is added / selected.
* Make a clear roadmap of our goals for the next 2 years in each domain of code, outreach, design and content. Start towards implementation of those goals according to priority.

I would like support from the community for my candidature for the post as a SLOB member.

Oversight Board/2018-2020-candidates/Rahul Bothra

2018-11-30T02:25:42Z

Pro-panda:

Hi everyone,
I am Rahul Bothra (pro-panda). I am a Python Developer and [http://lists.sugarlabs.org/archive/sugar-devel/2018-February/055080.html code reviewer] for Sugar Labs.

I was a GSoC' 18 student with Sugar Labs, and I worked on [https://summerofcode.withgoogle.com/archive/2018/projects/5320748025511936/ porting Sugar to Python 3]. I continue contributing in terms of code, code reviews and as a mentor in GCI' 18.

I am excited by our goals and our potential. But I am concerned that the way we are working is wrong.
'''Currently in the SLOB meetings,'''
* A lot of the members are inactive. They don't attend the SLOB meetings or reply to motions, crippling our progress.
* There is a lot of talk, but there is not an equivalent amount of work done. We fail to properly materialise discussions
* We don't have a concrete plan of our goals. We try to cover a lot of breath in our efforts, and end up working on things which are not related to our goals (eg: Sugar Social)
* We drag work for a lot of time, (eg: ASLO v3) a direct result of inactive mentoring and checks during GSoC
* Lack of concern about the number of developers working on Sugar and its activities. We are failing in attracting new consistent developers for it, despite being a popular GSoC and GCI organisation.

'''What I will undertake once elected:'''
* Attend every SLOB meeting regularly
* Revamping how we conduct GCI and GSoC to attract more contributions as well as improve the quality of mentoring; making sure we prioritise tasks which are more important to us, adding more checks before adding developers, grooming of every task / project before it is added / selected.
* Make a clear roadmap of our goals for the next 2 years in each domain of code, outreach, design and content. Start towards implementation of those goals according to priority.

I would like support from the community for my candidature for the post as a SLOB member.

Oversight Board/2018-2020-candidates/Rahul Bothra

2018-11-30T02:25:21Z

Pro-panda:

Hi everyone,
I am Rahul Bothra (pro-panda). I am a Python Developer and [http://lists.sugarlabs.org/archive/sugar-devel/2018-February/055080.html code reviewer] for Sugar Labs.

I was a GSoC' 18 student with Sugar Labs, and I worked on [https://summerofcode.withgoogle.com/archive/2018/projects/5320748025511936/ porting Sugar to Python 3]. I continue contributing in terms of code, code reviews and as a mentor in GCI' 18.

I am excited by our goals and our potential. But I am concerned that the way we are working is wrong. '''Currently in the SLOB meetings,'''
* A lot of the members are inactive. They don't attend the SLOB meetings or reply to motions, crippling our progress.
* There is a lot of talk, but there is not an equivalent amount of work done. We fail to properly materialise discussions
* We don't have a concrete plan of our goals. We try to cover a lot of breath in our efforts, and end up working on things which are not related to our goals (eg: Sugar Social)
* We drag work for a lot of time, (eg: ASLO v3) a direct result of inactive mentoring and checks during GSoC
* Lack of concern about the number of developers working on Sugar and its activities. We are failing in attracting new consistent developers for it, despite being a popular GSoC and GCI organisation.

'''What I will undertake once elected:'''
* Attend every SLOB meeting regularly
* Revamping how we conduct GCI and GSoC to attract more contributions as well as improve the quality of mentoring; making sure we prioritise tasks which are more important to us, adding more checks before adding developers, grooming of every task / project before it is added / selected.
* Make a clear roadmap of our goals for the next 2 years in each domain of code, outreach, design and content. Start towards implementation of those goals according to priority.

I would like support from the community for my candidature for the post as a SLOB member.

Oversight Board/2018-2020-candidates/Rahul Bothra

2018-11-27T19:07:54Z

Pro-panda:

Hi everyone,
I am Rahul Bothra (pro-panda). I am a Python Developer and [http://lists.sugarlabs.org/archive/sugar-devel/2018-February/055080.html code reviewer] for Sugar Labs.

I was a GSoC' 18 student with Sugar Labs, and I worked on [https://summerofcode.withgoogle.com/archive/2018/projects/5320748025511936/ porting Sugar to Python 3]. I continue contributing in terms of code, code reviews and as a mentor in GCI' 18.

I am excited our goals and our potential. But I am concerned that the way we are working is wrong. Currently in the SLOB meetings,
* A lot of the members are inactive. They don't attend the SLOB meetings or reply to motions, crippling our progress.
* There is a lot of talk, but there is not an equivalent amount of work done. We fail to properly materialise discussions
* We don't have a concrete plan of our goals. We try to cover a lot of breath in our efforts, and end up working on things which are not related to our goals (eg: Sugar Social)
* We drag work for a lot of time, (eg: ASLO v3) a direct result of inactive mentoring and checks during GSoC

I also feel there is a lack of concern about the number of developers working on Sugar and the activities. We are failing in attracting new consistent developers despite being a popular GSoC and GCI organisation.

What I will undertake once elected:
* Attend every SLOB meeting regularly
* Revamping how we conduct GCI and GSoC to attract more contributions as well as improve the quality of mentoring; making sure we prioritise tasks which are more important to us, adding more checks before adding developers, grooming of every task / project before it is added / selected.
* Make a clear roadmap of our goals for the next 2 years in each domain of code, outreach, design and content. Start towards implementation of those goals according to priority.

I would like support from the community for my candidature for the post as a SLOB member.

Oversight Board/2018-2020-candidates/Rahul Bothra

2018-11-24T21:07:10Z

Pro-panda:

Hi everyone,
I am Rahul Bothra (pro-panda). I am a Python Developer and [http://lists.sugarlabs.org/archive/sugar-devel/2018-February/055080.html code reviewer] for Sugar Labs.

I was a GSoC' 18 student with Sugar Labs, and I worked on [https://summerofcode.withgoogle.com/archive/2018/projects/5320748025511936/ porting Sugar to Python 3]. I continue contributing in terms of code, code reviews and as a mentor in GCI' 18.

I am excited our goals and our potential. But I am concerned that the way we are working is wrong. Currently in the SLOB meetings,
* A lot of the members are inactive. They don't attend the SLOB meetings or reply to motions, crippling our progress.
* There is a lot of talk, but there is not an equivalent amount of work done. We fail to properly materialise discussions
* We don't have a concrete plan of our goals. We try to cover a lot of breath in our efforts, and end up working on things which are not related to our goals (eg: Sugar Social)
* We drag work for a lot of time, (eg: ASLO v3) a direct result of inactive mentoring and checks during GSoC

I also feel there is a lack of concern about the number of developers working on Sugar and the activities. We are failing in attracting new consistent developers despite being a popular GSoC and GCI organisation.

What I will undertake once elected:
* Attend every SLOB meeting regularly
* Revamping how we conduct GCI and GSoC to attract more contributions; prioritising tasks which are more important to us, and improving mentoring checks to ensure that mentors are active
* Work on a roadmap of our goals across various domains and timelines, and try to make sure they are implemented

I would like support from the community for my candidature for the post as a SLOB member.

Oversight Board/2018-2020-candidates/Rahul Bothra

2018-11-24T20:59:29Z

Pro-panda: SLOB Election Candidature - Rahul Bothra

Hi everyone,
I am Rahul Bothra (pro-panda). I am a Python Developer and [http://lists.sugarlabs.org/archive/sugar-devel/2018-February/055080.html code reviewer] for Sugar Labs.

I was a GSoC' 18 student with Sugar Labs, and I worked on [https://summerofcode.withgoogle.com/archive/2018/projects/5320748025511936/ porting Sugar to Python 3]. I continue contributing in terms of code, code reviews and as a mentor in GCI' 18.

I am excited our goals and our potential. But I am concerned that the way we are working is wrong. Currently in the SLOB meetings,
* A lot of the members are inactive. They don't attend the SLOB meetings or reply to motions, crippling our progress.
* There is a lot of talk, but there is not an equivalent amount of work done. We fail to properly materialise discussions
* We don't have a concrete plan of our goals. We try to cover a lot of breath in our efforts, but fail to reach the right depth

I also feel there is a lack of concern about the number of developers working on Sugar and the activities. We are failing in attracting new consistent developers despite being a popular GSoC and GCI organisation.

What I will undertake once elected:
* Attend every SLOB meeting regularly
* Revamping how we conduct GCI and GSoC to attract more contributions; prioritising tasks which are more important to us, and improving mentoring checks to ensure that mentors are active
* Work on a roadmap of our goals across various domains and timelines

I would like support from the community for my candidature for the post as a SLOB member.

Google Code In 2018

2018-09-13T02:45:53Z

Pro-panda:

<noinclude>[[Category:Trac Reference]][[Category:Idea]]
[[Category: GCI2018]]</noinclude>

This is the project page for the Sugar Labs [https://opensource.googleblog.com/2018/10/welcoming-25-mentor-organizations-for.html application] to [https://developers.google.com/open-source/gci/ Google Code In 2018]. Sugar Labs community members: please feel free to add tasks below.

== Message to potential participants ==

It is important that you obtain permission of your parents.

Es importante que obtengas el permiso de tus padres para participar.

Please see the Contest Rules for Eligibility and Registration process.

https://developers.google.com/open-source/gci/resources/contest-rules

'''Details regarding the required forms and paperwork are here: [[Google Code In 2018/Participate#Students]].'''

Also, you will likely need to set up the Sugar development environment. See http://developer.sugarlabs.org/dev-environment.md.html for details. Further information about contributing to the project can be found here: http://developer.sugarlabs.org/

Please don't hesitate to ask questions on our irc channel (#sugar on irc.freenode.net) or on the sugar-devel list: sugar-devel AT lists.sugarlabs DOT org

== Why Sugar Labs is participating ==

Sugar is written and maintained by volunteers, who range from seasoned professionals to children as young as 12-years of age. Children who have grown up with Sugar have transitioned from Sugar users to Sugar App developers to Sugar maintainers. They hang out on IRC with the global Sugar developer community and are full-fledged members of the Sugar development team. It is this latter group of children we hope will participate in and benefit from Google Code-in. Specifically we want to re-enforce the message that Sugar belongs to its users and that they have both ownership and the responsibility that ownership implies. Just as learning is not something done to you, but something you do, learning with Sugar ultimately means participating in the Sugar development process. At Sugar Labs, we are trying to bring the culture of Free Software into the culture of school. So the Code-in is not just an opportunity for us to get some tasks accomplished, it is quintessential to our overall mission.

== Some background from GCI ==

[See https://developers.google.com/open-source/gci/resources/getting-started]

===Open Source Fundamentals ===

You can contribute without being a coder!
You do not have to be a coder to contribute to open source. There are many different skill sets needed to help an open source community thrive:
;Documentation: If you are a good writer and enjoy attention to detail then you might want to contribute by writing or editing documentation. Documentation is a huge part of a successful open source project. Organizations need documentation to help attract new contributors as it helps them see what the codebase looks like and where things are and what the plan is for the project.
;Research: An organization may need help crunching numbers or sorting through pages of documents to better understand what the users want or need. There are many different types of tasks that students could work on that are very important to the health of the project.
;Outreach: If you have an outgoing personality and like being around and talking to people, take a look at the outreach tasks. Outreach tasks often include hosting meetups in your local community or creating a plan on how people around the globe can host a meetup about the project in their local communities.
;Training: You could create a YouTube video discussing a new feature of the project or maybe some basics on what the project does so people who haven’t heard about it can understand the project and get involved.
;User Interface: User interface can include many types of tasks including designing new aspects of a webpage or creating a new logo for the project. It may also include various accessibility opportunities to help make the project easier for people who are blind.
;Other: If you have an idea that may help an organization, reach out to them and let them know! Sometimes the best task is one that the organization hasn’t even considered yet.
=== Collaboration===
Open source is not just about coding but working with other people to find the best solution. Being a part of the community is an essential part of success in Google Code-in. Mentors tell us every year that their best students were the ones who worked hard on their projects but also participated on IRC and helped answer questions other students had. Collaborate with the community and mentors on the #sugar channel in the irc.freenode.net network.

=== Quality over Quantity ===

It’s not about being the student who completes the most tasks, that only gets you to the top 10 to be reviewed, it doesn’t mean you will be a grand prize winner. We have had quite a few students who completed the most tasks for their organization yet were not named as Grand Prize Winners because they did everything solo and didn’t get involved in the community or think about the health of the project as a whole, they just kept completing task after task like a machine. If you actively participate in the community then you not only feel the camaraderie that comes with working as a team but you become committed to making the project better for everyone.

== Some basics about Sugar Labs and Sugar development ==

For some basics about the project, see [http://people.sugarlabs.org/walter/docs/Learning-to-Change-the-World-Chapter-4.pdf Chapter 4 of Learning to Change the World].

{{:Google Code In 2018/background}}

== This is a stub for 25+ example tasks new for GCI 2018. ==

Note, more detailed task descriptions will be available once the contest begins.

=== beginner tasks ===
# Install the Sugar development environment by following the instruction at [http://developer.sugarlabs.org/dev-environment.md.html].
# Install Sugar in a virtual machine.
# Install Sugar packages on Ubuntu, Debian, or Fedora.
# Create an example program in Turtle Blocks (See [https://www.pinterest.com/walterbender/turtle-art/] for some ideas).
# Create an example program in Music Blocks.
# Create a simple machine in Physics.

=== general tasks ===
# Organize a Turtle Art Day (or Music Blocks Day) in your community (Outreach)
# Create a 60 second promotional video on Sugar and its community (Outreach)
# Host a Question and Answer (Q&A)/Information session about Sugar on Google Hangouts. (Outreach)
# DIY Sugar on a Stick||Organize and host a Sugar on a Stick party where you show people how to make their own Sugar on a Stick. (Outreach)
# Find an educator who is using open-source educational software to teach. Interview the educator about their experience as an educator and why they are using open-source software to teach. (Outreach)
# Write a blog post about your experience as a GCI participant for Sugar Labs. (Outreach)
# Create a 10-minute presentation celebrating at least three women within the Sugar community and/or the open-source community at large. (Research/Outreach)
# Gather information on who could benefit from using or knowing about Sugar. (Research)
# Find the resources that people are using throughout the world to learn about or teach Sugar Activities. (Research)
# Find the missing repo: we've lost track of the source repository of some Sugar activities: help us find them (Research)
# Investigate Google Fuzzing tool (Research)
# Add more synths/sound fonts to Music Blocks (Research)
# Design the music equivalent of Turtle Confusion for Music Blocks (Research)
# Wiki cleanup (Documentation)
# Music Blocks examples (Documentation/Training)
# Write a review about an Activity in Sugar. (Documentation)
# How should the Sugar UI change to accommodate a small screen? (User interface)
# What else should be made easier to customize in Sugar with minimal programming? (User interface)
# Create a unit tests for a JavaScript activity (Quality assurance)
# Bugzilla clean up (Quality assurance)
# Refactor Turtle graphics to adopt look of Javascript version (Code: Python)
# Write a Pinetrest plugin for the Sugar Journal (Code: Python)
# Investigate CSound/Python version of Music Blocks (Code: Python)
# Resolve an open issue from https://github.com/sugarlabs/ (Code: Python)
# Teach me how to draw activity (Code: Javascript)
# Plugin manager for Turtle JS (Code: Javascript)
# Improvements to Lilypond interface (Code: Javascript)
# Add ABC import to Music Blocks (Code: Javascript)
# Add Lilypond import to Music Blocks (Code: Javascript)
# Write a Turtle plugin (Code: Javascript)
# Visualize turtle movements in Pitch-Time Matrix (Code: Javascript)
# Visualize turtle pitch in Music Blocks widget (Code: Javascript)
# Write a extruder in JavaScript to convert from SVG to STL for 3D printing. (Code: JavaScript)
# Write a slicer in JavaScript to convert between SL and GCODE for 3D printing. (Code: JavaScript)
# Resolve an open issue from https://github.com/walterbender/musicblocks/ (Code: JavaScript)

Mentors: please feel free to add more tasks and/or add yourself as a potential mentor to an existing task.

Tasks must fall within one of these five categories: [[#Documentation/Training]]; [[#Outreach/Research]]; [[#User Interface]]; [[#Quality Assurance]]; and [[#Code]].

== Mentors ==
;NOTES TO MENTORS:
:Please refer to [[Google Code In 2018/Participate#Mentors]] for details regarding enrolling as a mentor.
:Please add yourself to the list below.
:Feel free to add new tasks to the table above.

Depending on the task, we will assign multiple mentors from our various development and support teams.

* Walter Bender - co-administrator
* [mailto:rrbothra@gmail.com Rahul Bothra]
* Ignacio Rodriguez
* Hrishi Patel
* Tayba Wasim (Tabs16)
* Ibiam Chihurumnaya - co-administrator
* Rishabh Thaney
* Samson Goddy
* Jaskirat Singh

Python 2to3

2018-08-11T05:55:31Z

Pro-panda:

== Project Introduction ==
Sugar currently uses Python 2. Since support for python 2 is being drawn, we are porting our code to Python 3.

It is one of the [https://wiki.sugarlabs.org/go/Goals/2018_Submissions/Migrate_all_core_Sugar_Labs_code_to_Python3 goals for Sugar Labs] for 2018, with a suggested timeframe of ~12-16 months for completing the project.

The project was taken up by Sugar Labs in [https://wiki.sugarlabs.org/go/Summer_of_Code/2018 Google Summer of Code 2018]

== Project Summary ==
The project progress can be tracked [https://github.com/orgs/sugarlabs/projects/1 here].

;Sugar
: Target: Port entirely to Python 3
: WIP: https://github.com/Pro-Panda/sugar/tree/python3
: Status: While some critical issues still persist, most of the functionality is running and tested.

;Sugar-Toolkit-Gtk3
: Target: Should be compatible with both Python 2 and Python 3, to support the large number of activities currently in Python 2
: WIP: https://github.com/Pro-Panda/sugar-toolkit-gtk3/tree/python3-port
: Status: Mostly Complete; what remains is an entire project in itself of [https://github.com/orgs/sugarlabs/projects/4 porting the Telepathy Bindings].
: Critical changes implelmented:
:* Python 3 activities must be instantiated with sugar-activity3 instead of sugar-activity
:* sugar-activity-web will call the Python 3 version of the toolkit and will be installed only with the same
:* warning logged if activity is not ported to Python 3
Note: To test the toolkit without porting the telepathy bindings, please use the Python 3 bindings (not for release), https://github.com/pro-panda/telepathy3

;Sugar-Datastore
: Target: Port entirely to Python 3
: WIP: https://github.com/Pro-Panda/sugar-datastore/tree/python3-port
: Status: Complete(possible fix patches do come up while porting sugar); Fedora packaging and testing remains

;Sugar-Artwork
: Target: Port entirely to Python 3 (use system empy bindings for Python 3)
: WIP: https://github.com/Pro-Panda/sugar-artwork/tree/python3-port
: Status: Complete; Fedora packaging and testing remains

;Sugar Desktop Activities
: Guide to porting activities to Python 3 is [https://github.com/sugarlabs/sugar-docs/blob/master/src/python-porting-guide.md here]
{| style="text-align: center;"
! | Activity
! Status [WIP/Ported]
! Pull Request
|-

|Log
|Ported
|[https://github.com/sugarlabs/log-activity/issues/9 PR link]
|-

|JukeBox
|Ported
|[https://github.com/sugarlabs/jukebox-activity/pull/20 PR link]
|-

|Abacus
|Ported
|[https://github.com/sugarlabs/activity-abacus/pull/15 PR link]
|-

|Calculate
|Ported
|[https://github.com/sugarlabs/sugarlabs-calculate/issues/53 PR link]
|-

|Chat
|Ported
|[https://github.com/sugarlabs/chat/issues/13 PR link]
|-

|CowBulls
|Ported
|[https://github.com/sugarlabs/CowBulls-activity/issues/11 PR link]
|-

|Finance
|Ported
|[https://github.com/sugarlabs/finance-activity/issues/16 PR link]
|-

|Hello-world
|Ported
|[https://github.com/sugarlabs/hello-world/issues/3 PR link]
|-

|Imageviewer
|Ported
|[https://github.com/sugarlabs/imageviewer-activity/issues/26 PR link]
|-

|Read
|Ported
|[https://github.com/sugarlabs/read-activity/issues/21 PR link]
|-

|Spirolaterals
|Ported
|[https://github.com/sugarlabs/spirolaterals/issues/12 PR link]
|-

|Terminal
|Ported
|[https://github.com/sugarlabs/terminal-activity/issues/29 PR link]
|-

|Write
|Ported
|[https://github.com/sugarlabs/write-activity/issues/24 PR link]
|-

|Nutrition
|Ported
|[https://github.com/sugarlabs/nutrition/issues/4 PR link]
|-

|}

== Contributing to the Project ==
There are several ways of contributing to the project
; Port Telepathy bindings
: Telepathy does not have python 3 bindings and needs to be ported to its PyGObject bindings as a prerequisite for porting to Python 3
: See https://github.com/orgs/sugarlabs/projects/4

; Test Debian Packages
: Debian packages for core modules here: https://github.com/Pro-Panda/sugar-packages
: Please install, test and report bugs, (or better, submit fix patches)

; Fedora Packaging
: Make Fedora packages of core modules (WIP links above) and test them

; Port Sugar Desktop Activities to Python 3:
: See the guide to port activities to Python 3: https://github.com/sugarlabs/sugar-docs/blob/master/src/python-porting-guide.md

; Improve test coverage
: Sugar and the components lack in testing mechanisms and scripts. Our current test coverage is very basic and minimal. Improving the same is critical and the best time would be to so while Porting and testing the components
: Some test scripts are here - https://github.com/Pro-Panda/sugar-python3-tests

== Notes ==
* httplib.HTTP is not available in Python 3; use http.client.HTTPConnection instead
* cmp function does not exist in Python 3, use the cmp_to_key function; see https://docs.python.org/3/howto/sorting.html#sortinghowto
* list.sort function requires named parameters in Python 3
* hashlib.md5 requires bytes as an argument in Python 3
* sha_hash.update requires bytes as an argument in Python 3
* statvfs does not exist in Python 3, verify the Python 2 constant values and use them instead

Python 2to3

2018-08-11T05:55:00Z

Pro-panda: Update project links

== Project Introduction ==
Sugar currently uses Python 2. Since support for python 2 is being drawn, we are porting our code to Python 3.

It is one of the [https://wiki.sugarlabs.org/go/Goals/2018_Submissions/Migrate_all_core_Sugar_Labs_code_to_Python3 goals for Sugar Labs] for 2018, with a suggested timeframe of ~12-16 months for completing the project.

The project was taken up by Sugar Labs in [https://wiki.sugarlabs.org/go/Summer_of_Code/2018 Google Summer of Code 2018]

== Project Summary ==
The project progress can be tracked [https://github.com/orgs/sugarlabs/projects/1 here].

;Sugar
: Target: Port entirely to Python 3
: WIP: https://github.com/Pro-Panda/sugar/tree/python3
: Status: While some critical issues still persist, most of the functionality is running and tested.

;Sugar-Toolkit-Gtk3
: Target: Should be compatible with both Python 2 and Python 3, to support the large number of activities currently in Python 2
: WIP: https://github.com/Pro-Panda/sugar-toolkit-gtk3/tree/python3-port
: Status: Mostly Complete; what remains is an entire project in itself of [https://github.com/orgs/sugarlabs/projects/4 porting the Telepathy Bindings].
: Critical changes implelmented:
:* Python 3 activities must be instantiated with sugar-activity3 instead of sugar-activity
:* sugar-activity-web will call the Python 3 version of the toolkit and will be installed only with the same
:* warning logged if activity is not ported to Python 3
Note: To test the toolkit without porting the telepathy bindings, please use the Python 3 bindings (note for release), https://github.com/pro-panda/telepathy3

;Sugar-Datastore
: Target: Port entirely to Python 3
: WIP: https://github.com/Pro-Panda/sugar-datastore/tree/python3-port
: Status: Complete(possible fix patches do come up while porting sugar); Fedora packaging and testing remains

;Sugar-Artwork
: Target: Port entirely to Python 3 (use system empy bindings for Python 3)
: WIP: https://github.com/Pro-Panda/sugar-artwork/tree/python3-port
: Status: Complete; Fedora packaging and testing remains

;Sugar Desktop Activities
: Guide to porting activities to Python 3 is [https://github.com/sugarlabs/sugar-docs/blob/master/src/python-porting-guide.md here]
{| style="text-align: center;"
! | Activity
! Status [WIP/Ported]
! Pull Request
|-

|Log
|Ported
|[https://github.com/sugarlabs/log-activity/issues/9 PR link]
|-

|JukeBox
|Ported
|[https://github.com/sugarlabs/jukebox-activity/pull/20 PR link]
|-

|Abacus
|Ported
|[https://github.com/sugarlabs/activity-abacus/pull/15 PR link]
|-

|Calculate
|Ported
|[https://github.com/sugarlabs/sugarlabs-calculate/issues/53 PR link]
|-

|Chat
|Ported
|[https://github.com/sugarlabs/chat/issues/13 PR link]
|-

|CowBulls
|Ported
|[https://github.com/sugarlabs/CowBulls-activity/issues/11 PR link]
|-

|Finance
|Ported
|[https://github.com/sugarlabs/finance-activity/issues/16 PR link]
|-

|Hello-world
|Ported
|[https://github.com/sugarlabs/hello-world/issues/3 PR link]
|-

|Imageviewer
|Ported
|[https://github.com/sugarlabs/imageviewer-activity/issues/26 PR link]
|-

|Read
|Ported
|[https://github.com/sugarlabs/read-activity/issues/21 PR link]
|-

|Spirolaterals
|Ported
|[https://github.com/sugarlabs/spirolaterals/issues/12 PR link]
|-

|Terminal
|Ported
|[https://github.com/sugarlabs/terminal-activity/issues/29 PR link]
|-

|Write
|Ported
|[https://github.com/sugarlabs/write-activity/issues/24 PR link]
|-

|Nutrition
|Ported
|[https://github.com/sugarlabs/nutrition/issues/4 PR link]
|-

|}

== Contributing to the Project ==
There are several ways of contributing to the project
; Port Telepathy bindings
: Telepathy does not have python 3 bindings and needs to be ported to its PyGObject bindings as a prerequisite for porting to Python 3
: See https://github.com/orgs/sugarlabs/projects/4

; Test Debian Packages
: Debian packages for core modules here: https://github.com/Pro-Panda/sugar-packages
: Please install, test and report bugs, (or better, submit fix patches)

; Fedora Packaging
: Make Fedora packages of core modules (WIP links above) and test them

; Port Sugar Desktop Activities to Python 3:
: See the guide to port activities to Python 3: https://github.com/sugarlabs/sugar-docs/blob/master/src/python-porting-guide.md

; Improve test coverage
: Sugar and the components lack in testing mechanisms and scripts. Our current test coverage is very basic and minimal. Improving the same is critical and the best time would be to so while Porting and testing the components
: Some test scripts are here - https://github.com/Pro-Panda/sugar-python3-tests

== Notes ==
* httplib.HTTP is not available in Python 3; use http.client.HTTPConnection instead
* cmp function does not exist in Python 3, use the cmp_to_key function; see https://docs.python.org/3/howto/sorting.html#sortinghowto
* list.sort function requires named parameters in Python 3
* hashlib.md5 requires bytes as an argument in Python 3
* sha_hash.update requires bytes as an argument in Python 3
* statvfs does not exist in Python 3, verify the Python 2 constant values and use them instead

Python 2to3

2018-08-11T05:18:42Z

Pro-panda:

== Project Introduction ==
Sugar currently uses Python 2. Since support for python 2 is being drawn, we are porting our code to Python 3.

It is one of the [https://wiki.sugarlabs.org/go/Goals/2018_Submissions/Migrate_all_core_Sugar_Labs_code_to_Python3 goals for Sugar Labs] for 2018, with a suggested timeframe of ~12-16 months for completing the project.

The project was taken up by Sugar Labs in [https://wiki.sugarlabs.org/go/Summer_of_Code/2018 Google Summer of Code 2018]

== Project Summary ==
The project progress can be tracked [https://github.com/orgs/sugarlabs/projects/1 here].

;Sugar
: Target: Port entirely to Python 3
: WIP: https://github.com/Pro-Panda/sugar/tree/python3
: Status: While some critical issues still persist, most of the functionality is running and tested.

;Sugar-Toolkit-Gtk3
: Target: Should be compatible with both Python 2 and Python 3, to support the large number of activities currently in Python 2
: WIP: https://github.com/Pro-Panda/sugar-toolkit-gtk3/tree/python3-port
: Status: Mostly Complete; what remains is an entire project in itself of [https://github.com/orgs/sugarlabs/projects/4 porting the Telepathy Bindings].
Note: To test the toolkit without porting the telepathy bindings, please use the Python 3 bindings (note for release), https://github.com/pro-panda/telepathy3

;Sugar-Datastore
: Target: Port entirely to Python 3
: WIP: https://github.com/Pro-Panda/sugar-datastore/tree/python3-port
: Status: Complete(possible fix patches do come up while porting sugar); Fedora packaging and testing remains

;Sugar-Artwork
: Target: Port entirely to Python 3 (use system empy bindings for Python 3)
: WIP: https://github.com/Pro-Panda/sugar-artwork/tree/python3-port
: Status: Complete; Fedora packaging and testing remains

;Sugar Desktop Activities

{| style="text-align: center;"
! | Activity
! Status [WIP/Ported]
! Pull Request
|-

|Log
|Ported
|[https://github.com/sugarlabs/log-activity/issues/9 PR link]
|-

|JukeBox
|Ported
|[https://github.com/sugarlabs/jukebox-activity/pull/20 PR link]
|-

|Abacus
|Ported
|[https://github.com/sugarlabs/activity-abacus/pull/15 PR link]
|-

|Calculate
|Ported
|[https://github.com/sugarlabs/sugarlabs-calculate/issues/53 PR link]
|-

|Chat
|Ported
|[https://github.com/sugarlabs/chat/issues/13 PR link]
|-

|CowBulls
|Ported
|[https://github.com/sugarlabs/CowBulls-activity/issues/11 PR link]
|-

|Finance
|Ported
|[https://github.com/sugarlabs/finance-activity/issues/16 PR link]
|-

|Hello-world
|Ported
|[https://github.com/sugarlabs/hello-world/issues/3 PR link]
|-

|Imageviewer
|Ported
|[https://github.com/sugarlabs/imageviewer-activity/issues/26 PR link]
|-

|Read
|Ported
|[https://github.com/sugarlabs/read-activity/issues/21 PR link]
|-

|Spirolaterals
|Ported
|[https://github.com/sugarlabs/spirolaterals/issues/12 PR link]
|-

|Terminal
|Ported
|[https://github.com/sugarlabs/terminal-activity/issues/29 PR link]
|-

|Write
|Ported
|[https://github.com/sugarlabs/write-activity/issues/24 PR link]
|-

|Nutrition
|Ported
|[https://github.com/sugarlabs/nutrition/issues/4 PR link]
|-

|}

== Contributing to the Project ==
There are several ways of contributing to the project
; Port Telepathy bindings
: Telepathy does not have python 3 bindings and needs to be ported to its PyGObject bindings as a prerequisite for porting to Python 3
: See https://github.com/orgs/sugarlabs/projects/4

; Test Debian Packages
: Debian packages for core modules here: https://github.com/Pro-Panda/sugar-packages
: Please install, test and report bugs, (or better, submit fix patches)

; Fedora Packaging
: Make Fedora packages of core modules (WIP links above) and test them

; Port Sugar Desktop Activities to Python 3:
: See the guide to port activities to Python 3: https://github.com/sugarlabs/sugar-docs/blob/master/src/python-porting-guide.md

; Improve test coverage
: Sugar and the components lack in testing mechanisms and scripts. Our current test coverage is very basic and minimal. Improving the same is critical and the best time would be to so while Porting and testing the components
: Some test scripts are here - https://github.com/Pro-Panda/sugar-python3-tests

== Notes ==
* httplib.HTTP is not available in Python 3; use http.client.HTTPConnection instead
* cmp function does not exist in Python 3, use the cmp_to_key function; see https://docs.python.org/3/howto/sorting.html#sortinghowto
* list.sort function requires named parameters in Python 3
* hashlib.md5 requires bytes as an argument in Python 3
* sha_hash.update requires bytes as an argument in Python 3
* statvfs does not exist in Python 3, verify the Python 2 constant values and use them instead

Python 2to3

2018-07-29T05:53:12Z

Pro-panda:

== Project Introduction ==
Sugar currently uses Python 2. Since support for python 2 is being drawn, we are porting our code to Python 3.

It is one of the [https://wiki.sugarlabs.org/go/Goals/2018_Submissions/Migrate_all_core_Sugar_Labs_code_to_Python3 goals for Sugar Labs] for 2018, with a suggested timeframe of ~12-16 months for completing the project.

The project was taken up by Sugar Labs in [https://wiki.sugarlabs.org/go/Summer_of_Code/2018 Google Summer of Code 2018]

== Project Summary ==
The project progress can be tracked [https://github.com/orgs/sugarlabs/projects/1 here].

;Sugar
: Target: Port entirely to Python 3
: WIP: https://github.com/Pro-Panda/sugar/tree/python3
: Status: While some critical issues still persist, most of the functionality is running and tested.

;Sugar-Toolkit-Gtk3
: Target: Should be compatible with both Python 2 and Python 3, to support the large number of activities currently in Python 2
: WIP: https://github.com/Pro-Panda/sugar-toolkit-gtk3/tree/python3-port
: Status: Mostly complete; what remains is an entire project in itself of [https://github.com/orgs/sugarlabs/projects/4 porting the Telepathy Bindings]

;Sugar-Datastore
: Target: Port entirely to Python 3
: WIP: https://github.com/Pro-Panda/sugar-datastore/tree/python3-port
: Status: Complete(possible fix patches do come up while porting sugar); Fedora packaging and testing remains

;Sugar-Artwork
: Target: Port entirely to Python 3 (use system empy bindings for Python 3)
: WIP: https://github.com/Pro-Panda/sugar-artwork/tree/python3-port
: Status: Complete; Fedora packaging and testing remains

;Sugar Desktop Activities

{| style="text-align: center;"
! | Activity
! Status [WIP/Ported]
! Pull Request
|-

|Log
|Ported
|[https://github.com/sugarlabs/log-activity/issues/9 PR link]
|-

|JukeBox
|Ported
|[https://github.com/sugarlabs/jukebox-activity/pull/20 PR link]
|-

|Abacus
|Ported
|[https://github.com/sugarlabs/activity-abacus/pull/15 PR link]
|-

|Calculate
|Ported
|[https://github.com/sugarlabs/sugarlabs-calculate/issues/53 PR link]
|-

|Chat
|Ported
|[https://github.com/sugarlabs/chat/issues/13 PR link]
|-

|CowBulls
|Ported
|[https://github.com/sugarlabs/CowBulls-activity/issues/11 PR link]
|-

|Finance
|Ported
|[https://github.com/sugarlabs/finance-activity/issues/16 PR link]
|-

|Hello-world
|Ported
|[https://github.com/sugarlabs/hello-world/issues/3 PR link]
|-

|Imageviewer
|Ported
|[https://github.com/sugarlabs/imageviewer-activity/issues/26 PR link]
|-

|Read
|Ported
|[https://github.com/sugarlabs/read-activity/issues/21 PR link]
|-

|Spirolaterals
|Ported
|[https://github.com/sugarlabs/spirolaterals/issues/12 PR link]
|-

|Terminal
|Ported
|[https://github.com/sugarlabs/terminal-activity/issues/29 PR link]
|-

|Write
|Ported
|[https://github.com/sugarlabs/write-activity/issues/24 PR link]
|-

|Nutrition
|Ported
|[https://github.com/sugarlabs/nutrition/issues/4 PR link]
|-

|}

== Contributing to the Project ==
There are several ways of contributing to the project
; Port Telepathy bindings
: Telepathy does not have python 2 bindings and needs to be ported to its PyGObject bindings as a prerequisite for porting to Python 3
: See https://github.com/orgs/sugarlabs/projects/4

; Test Debian Packages
: Debian packages for core modules here: https://github.com/Pro-Panda/sugar-packages
: Please install, test and report bugs, (or better, submit fix patches)

; Fedora Packaging
: Make Fedora packages of core modules (WIP links above) and test them

; Port Sugar Desktop Activities to Python 3:
: See the guide to port activities to Python 3: https://github.com/sugarlabs/sugar-docs/blob/master/src/python-porting-guide.md

; Improve test coverage
: Sugar and the components lack in testing mechanisms and scripts. Our current test coverage is very basic and minimal. Improving the same is critical and the best time would be to so while Porting and testing the components
: Some test scripts are here - https://github.com/Pro-Panda/sugar-python3-tests

== Notes ==
* httplib.HTTP is not available in Python 2; use http.client.HTTPConnection instead
* cmp function does not exist in Python 3, use the cmp_to_key function; see https://docs.python.org/3/howto/sorting.html#sortinghowto
* list.sort function requires named parameters in Python 3
* hashlib.md5 requires bytes as an argument in Python 3
* sha_hash.update requires bytes as an argument in Python 3
* statvfs does not exist in Python 3, verify the Python 2 constant values and use them instead

User:Pro-panda:gsoc-project

2018-07-29T05:21:52Z

Pro-panda: Created page with "=== Project details === Implement Cross Version Python Support for Sugar Project summary and progress can be seen https://wiki.sugarlabs.org/go/Python_2to3 === Work Completed..."

Python 2to3

2018-07-29T05:10:03Z

Pro-panda: /* Port Sugar Labs' Python code to Python 3 */

== Project Introduction ==
Sugar currently uses Python 2. Since support for python 2 is being drawn, we are porting our code to Python 3.

It is one of the [https://wiki.sugarlabs.org/go/Goals/2018_Submissions/Migrate_all_core_Sugar_Labs_code_to_Python3 goals for Sugar Labs] for 2018, with a suggested timeframe of ~12-16 months for completing the project.

The project was taken up by Sugar Labs in [https://wiki.sugarlabs.org/go/Summer_of_Code/2018 Google Summer of Code 2018]

== Project Summary ==
The project progress can be tracked [https://github.com/orgs/sugarlabs/projects/1 here].

;Sugar
: Target: Port entirely to Python 3
: WIP: https://github.com/Pro-Panda/sugar/tree/python3
: Status: While some critical issues still persist, most of the functionality is running and tested.

;Sugar-Toolkit-Gtk3
: Target: Should be compatible with both Python 2 and Python 3, to support the large number of activities currently in Python 2
: WIP: https://github.com/Pro-Panda/sugar-toolkit-gtk3/tree/python3-port
: Status: Mostly complete; what remains is an entire project in itself of [https://github.com/orgs/sugarlabs/projects/4 porting the Telepathy Bindings]

;Sugar-Datastore
: Target: Port entirely to Python 3
: WIP: https://github.com/Pro-Panda/sugar-datastore/tree/python3-port
: Status: Complete(possible fix patches do come up while porting sugar); Fedora packaging and testing remains

;Sugar-Artwork
: Target: Port entirely to Python 3 (use system empy bindings for Python 3)
: WIP: https://github.com/Pro-Panda/sugar-artwork/tree/python3-port
: Status: Complete; Fedora packaging and testing remains

;Sugar Desktop Activities

{| style="text-align: center;"
! | Activity
! Status [WIP/Ported]
! Pull Request
|-

|Log
|Ported
|[https://github.com/sugarlabs/log-activity/issues/9 PR link]
|-

|JukeBox
|Ported
|[https://github.com/sugarlabs/jukebox-activity/pull/20 PR link]
|-

|Abacus
|Ported
|[https://github.com/sugarlabs/activity-abacus/pull/15 PR link]
|-

|Calculate
|Ported
|[https://github.com/sugarlabs/sugarlabs-calculate/issues/53 PR link]
|-

|Chat
|Ported
|[https://github.com/sugarlabs/chat/issues/13 PR link]
|-

|CowBulls
|Ported
|[https://github.com/sugarlabs/CowBulls-activity/issues/11 PR link]
|-

|Finance
|Ported
|[https://github.com/sugarlabs/finance-activity/issues/16 PR link]
|-

|Hello-world
|Ported
|[https://github.com/sugarlabs/hello-world/issues/3 PR link]
|-

|Imageviewer
|Ported
|[https://github.com/sugarlabs/imageviewer-activity/issues/26 PR link]
|-

|Read
|Ported
|[https://github.com/sugarlabs/read-activity/issues/21 PR link]
|-

|Spirolaterals
|Ported
|[https://github.com/sugarlabs/spirolaterals/issues/12 PR link]
|-

|Terminal
|Ported
|[https://github.com/sugarlabs/terminal-activity/issues/29 PR link]
|-

|Write
|Ported
|[https://github.com/sugarlabs/write-activity/issues/24 PR link]
|-

|Nutrition
|Ported
|[https://github.com/sugarlabs/nutrition/issues/4 PR link]
|-

|}

== Contributing to the Project ==
There are several ways of contributing to the project
; Port Telepathy bindings
: Telepathy does not have python 2 bindings and needs to be ported to its PyGObject bindings as a prerequisite for porting to Python 3
: See https://github.com/orgs/sugarlabs/projects/4

; Test Debian Packages
: Debian packages for core modules here: https://github.com/Pro-Panda/sugar-packages
: Please install, test and report bugs, (or better, submit fix patches)

; Fedora Packaging
: Make Fedora packages of core modules (WIP links above) and test them

; Port Sugar Desktop Activities to Python 3:
: See the guide to port activities to Python 3: https://github.com/sugarlabs/sugar-docs/blob/master/src/python-porting-guide.md

; Improve test coverage
: Sugar and the components lack in testing mechanisms and scripts. Our current test coverage is very basic and minimal. Improving the same is critical and the best time would be to so while Porting and testing the components
: Some test scripts are here - https://github.com/Pro-Panda/sugar-python3-tests

Python 2to3

2018-07-29T05:09:23Z

Pro-panda: Created page with "= Port Sugar Labs' Python code to Python 3 = == Project Introduction == Sugar currently uses Python 2. Since support for python 2 is being drawn, we are porting our code to P..."

= Port Sugar Labs' Python code to Python 3 =

== Project Introduction ==
Sugar currently uses Python 2. Since support for python 2 is being drawn, we are porting our code to Python 3.

It is one of the [https://wiki.sugarlabs.org/go/Goals/2018_Submissions/Migrate_all_core_Sugar_Labs_code_to_Python3 goals for Sugar Labs] for 2018, with a suggested timeframe of ~12-16 months for completing the project.

The project was taken up by Sugar Labs in [https://wiki.sugarlabs.org/go/Summer_of_Code/2018 Google Summer of Code 2018]

== Project Summary ==
The project progress can be tracked [https://github.com/orgs/sugarlabs/projects/1 here].

;Sugar
: Target: Port entirely to Python 3
: WIP: https://github.com/Pro-Panda/sugar/tree/python3
: Status: While some critical issues still persist, most of the functionality is running and tested.

;Sugar-Toolkit-Gtk3
: Target: Should be compatible with both Python 2 and Python 3, to support the large number of activities currently in Python 2
: WIP: https://github.com/Pro-Panda/sugar-toolkit-gtk3/tree/python3-port
: Status: Mostly complete; what remains is an entire project in itself of [https://github.com/orgs/sugarlabs/projects/4 porting the Telepathy Bindings]

;Sugar-Datastore
: Target: Port entirely to Python 3
: WIP: https://github.com/Pro-Panda/sugar-datastore/tree/python3-port
: Status: Complete(possible fix patches do come up while porting sugar); Fedora packaging and testing remains

;Sugar-Artwork
: Target: Port entirely to Python 3 (use system empy bindings for Python 3)
: WIP: https://github.com/Pro-Panda/sugar-artwork/tree/python3-port
: Status: Complete; Fedora packaging and testing remains

;Sugar Desktop Activities

{| style="text-align: center;"
! | Activity
! Status [WIP/Ported]
! Pull Request
|-

|Log
|Ported
|[https://github.com/sugarlabs/log-activity/issues/9 PR link]
|-

|JukeBox
|Ported
|[https://github.com/sugarlabs/jukebox-activity/pull/20 PR link]
|-

|Abacus
|Ported
|[https://github.com/sugarlabs/activity-abacus/pull/15 PR link]
|-

|Calculate
|Ported
|[https://github.com/sugarlabs/sugarlabs-calculate/issues/53 PR link]
|-

|Chat
|Ported
|[https://github.com/sugarlabs/chat/issues/13 PR link]
|-

|CowBulls
|Ported
|[https://github.com/sugarlabs/CowBulls-activity/issues/11 PR link]
|-

|Finance
|Ported
|[https://github.com/sugarlabs/finance-activity/issues/16 PR link]
|-

|Hello-world
|Ported
|[https://github.com/sugarlabs/hello-world/issues/3 PR link]
|-

|Imageviewer
|Ported
|[https://github.com/sugarlabs/imageviewer-activity/issues/26 PR link]
|-

|Read
|Ported
|[https://github.com/sugarlabs/read-activity/issues/21 PR link]
|-

|Spirolaterals
|Ported
|[https://github.com/sugarlabs/spirolaterals/issues/12 PR link]
|-

|Terminal
|Ported
|[https://github.com/sugarlabs/terminal-activity/issues/29 PR link]
|-

|Write
|Ported
|[https://github.com/sugarlabs/write-activity/issues/24 PR link]
|-

|Nutrition
|Ported
|[https://github.com/sugarlabs/nutrition/issues/4 PR link]
|-

|}

== Contributing to the Project ==
There are several ways of contributing to the project
; Port Telepathy bindings
: Telepathy does not have python 2 bindings and needs to be ported to its PyGObject bindings as a prerequisite for porting to Python 3
: See https://github.com/orgs/sugarlabs/projects/4

; Test Debian Packages
: Debian packages for core modules here: https://github.com/Pro-Panda/sugar-packages
: Please install, test and report bugs, (or better, submit fix patches)

; Fedora Packaging
: Make Fedora packages of core modules (WIP links above) and test them

; Port Sugar Desktop Activities to Python 3:
: See the guide to port activities to Python 3: https://github.com/sugarlabs/sugar-docs/blob/master/src/python-porting-guide.md

; Improve test coverage
: Sugar and the components lack in testing mechanisms and scripts. Our current test coverage is very basic and minimal. Improving the same is critical and the best time would be to so while Porting and testing the components
: Some test scripts are here - https://github.com/Pro-Panda/sugar-python3-tests

Summer of Code/2018

2018-05-29T22:10:07Z

Pro-panda: Fix blog link and update name

== Selected Projects for summer 2018 ==

;Rahul Bothra | Pro-Panda: Port Sucrose from Python 2 to Python 3 ([http://www.pro-panda.tech blog])
;Riya Lohia: Going Beyond Equal Temperament in Music Blocks ([https://medium.com/gsoc18-with-sugar-labs blog])
;Ritwik Abhishek: Music Blocks Widget Improvement ([https://musicblocks18.wordpress.com/ blog])
;Vaibhav Aren: Interactive Exercises for Turtle Blocks ([https://vaibhavdaren.wordpress.com/ blog])
;Aman Sharma: Sugarizer School Box ([https://amansharmablogblog.wordpress.com/2018/04/26/introduction-to-the-community/ blog])
;Vipul Gupta: Activity Migration ([https://mixstersite.wordpress.com/gsoc2018/ blog])
;Anmol Mishra: Port to Python 3 ([https://medium.com/anmolmishra-jiit blog])
;Iqra Muhammad: Sugarizer Primero ([https://iqragsoc.wordpress.com/ blog])
;Mankirat Singh: Sugarizer Exerciser Activity ([https://mankiratsinghtech.wordpress.com/2018/04/27/google-summer-of-code-2018/ blog])
;Rudra Sadhu: Migration of Activity wiki-pages to Git ([https://wiki.sugarlabs.org/go/Summer_of_Code/2018/attentive_migration_of_wiki_activity_pages_to_git project-details])([https://rdrsadhu.github.io/blog/gsoc2018/ blog]) [Weekly Meeting: Friday 16:00 CET (19:30 IST)]
;Yash Aragwal:Just say no to GTK+ 2 ([https://medium.com/@yashagrawal3/gsoc-18-with-sugar-labs-2d9bc733cf59 blog])
;Pratul Kumar:Beginner's Guide ([https://medium.com/@pratulkumar/gsoc-introduction-to-the-community-ed47e04e3051 blog])

[https://summerofcode.withgoogle.com/organizations/6193990685163520/ Sugar Labs at GSoC 2018]

=== Meetings ===

We meet as a group in IRC every Friday at 22IST, 12:30ET, 16:30UTC. The meetings are logged at http://meeting.sugarlabs.org/sugar-meeting/meetings

----

== Project Ideas ==

'''GSoC projects must involve some coding. Non-coding projects have been moved to the [[Summer of Code/2018/Archive|Non-Coding Projects Page]].'''

{| border="1" cellpadding="3" style="border: 1px solid white; border-collapse: collapse; background: #f7effc;"
|-style="background:#7409bc; color: white;"
!Title
!Mentor
!Project
|-
| valign=top width="15%" style="background:#fcfcfc;"|Python 3 port
| valign=top width="15%" style="background:#fcfcfc;"|Devel Team
| align=left valign=top style="background:#fcfcfc;"|
;Brief explanation: Python 3 has been here for quite some time. We've investigated how to migrate and now it is time to do it.
;Expected results: A Python 3 version of the Sugar toolkit, as well as the Sugar Desktop and a few activities.
;Knowledge prerequisites: Strong Python and GTK experience

|-
| valign=top width="15%" style="background:#f7effc;" |Migration of wiki activity pages to git
| valign=top width="15%" |Activity team
| align=left valign=top |
;Brief explanation: We have 345 pages under [[Activities]] in this wiki. It would be more sustainable in the long run if these pages were embedded (in Markdown format) in their corresponding git repositories.
;Expected results: Definition of migration process; migration of the majority of these pages
;Knowledge prerequisites: Knowledge of Markdown and Mediawiki markup; experience with git.

|-
| valign=top width="15%" style="background:#fcfcfc;"|GTK-4 exploration
| valign=top width="15%" style="background:#fcfcfc;"|Devel Team
| align=left valign=top style="background:#fcfcfc;"|
;Brief explanation: GTK-4 is coming soon [https://mclasen.fedorapeople.org/gtk4-devconf2018.pdf]: probably in 2018. We need to be better prepared for the transition than we were for GTK-3.
;Expected results: Design of a workflow for transitioning from GTK-3 to GTK-4
;Knowledge prerequisites: Strong Python and GTK experience

|-
| valign=top width="15%" style="background:#f7effc;" |Internationalization and Localization
| valign=top width="15%" |Chris Leonard
Shivang Shekhar
| align=left valign=top |
;Brief explanation: A goal of Sugar Labs is to enable our users to experience Sugar in their own native language. See [[Translation_Proposal#ToDo:|Translation Proposal To Do List]] for details. See [[Translation Team]] for framework description.
;Expected results: Work flow improvements for i18n
;Knowledge prerequisites: Some knowledge of Pootle; some scripting experience; Python and JavaScript

|-
| valign=top width="15%" style="background:#fcfcfc;"|Full-color icons
| valign=top width="15%" style="background:#fcfcfc;"|Design team Jaskirat Singh perriefidelis
| align=left valign=top style="background:#fcfcfc;"|
;Brief explanation: We have been discussing the implications of removing the duo-tone restriction on Sugar icons, allowing for full-color icons. We can likely use badges to compensate for any functionality we'd lose. (See [https://medium.com/@sidhant/designing-interfaces-for-education-systems-with-sugar-labs-rethinking-icons-on-sugar-614120e7ec6f] as one example of how we might proceed.). Like if an activity has not closed yet so it will be shown through a badge appearing on an icon. Repo can be found here https://github.com/sugarlabs/sugar-toolkit-gtk3/tree/master/src/sugar3
;Expected results: A patch to Sugar that uses badges to manage the icon notifications such as activity, sharing, achievements and much more.
;Knowledge prerequisites: Knowledge of GTK; Python.

|-
| valign=top width="15%" style="background:#fcfcfc;"|Learn to program in Turtle Blocks
| valign=top width="15%" style="background:#fcfcfc;"|Walter Bender Jaskirat Singh 
| align=left valign=top style="background:#fcfcfc;"|
;Brief explanation: In much the same way that [https://www.codecademy.com/courses/programming-intro/0/1#!/exercises/0 ( example here )] walks newbies through the basics of programming in Javascript, it would be nice to walk newbies through the basics of Turtle Blocks. There is already a provision within Turtle Blocks for programatically creating and moving blocks and executing program stacks. So it would be a matter of developing the exercises.
;Expected results: Website for teaching and having exercises with Turtle Blocks.
;Knowledge prerequisites: Requires some familiarity with Logo programming and Python.

|-
| valign=top width="15%" style="background:#f7effc;" |Music Blocks optimizations [[File:Music-Blocks.png|90px|thumb|center]]
| valign=top width="15%" | Walter Bender
| align=left valign=top |
;Brief explanation: Music Blocks has never been optimized in any way. It would be helpful to review the tone.js optimization recommendations, as well as build some unit tests to measure and improve the program itself.
;Expected results: A more robust and responsive Music Blocks.
;Knowledge prerequisites: Knowledge of JavaScript, unit testing

|-
| valign=top width="15%" style="background:#fcfcfc;"|Going Beyond Equal Temperament in Music Blocks [[File:Music-Blocks.png|90px|thumb|center]]
| valign=top width="15%" style="background:#fcfcfc;"| Walter Bender Devin Ulibarri Sachiko Nakajima Marnen Laibow-Koser
| align=left valign=top style="background:#fcfcfc;"|
;Brief explanation: Most modern music systems are designed around [https://en.wikipedia.org/wiki/Equal_temperament equal temperament]. But there are many ways to [https://en.wikipedia.org/wiki/Musical_temperament chose and tune notes] in a musical system that offer different expressive characteristics. See also [https://github.com/walterbender/musicblocks/labels/temperament MB issues for temperament], [https://owncloud.libretools.com/index.php/s/2GtAhkvQpt3fYfF Articles about temperament, scales, and tuning] and [https://owncloud.libretools.com/index.php/s/PmPfZ1yMhimQomG various materials related to temperament (.tb files that achieve temperament with existing MB features, videos of those files being performed, notes)]
;Expected results: Extend Music Blocks such that different approaches to temperament are available to the user.
;Knowledge prerequisites: Knowledge of JavaScript, music theory

|-
| valign=top width="15%" style="background:#f7effc;" |Just say no to GTK2
| valign=top width="15%" style="background:#f7effc;"| Ignacio Rodriguez Cristian Garcia Abhijit Patel Ibiam Chihurumnaya Hrishi Patel
| align=left valign=top style="background:#f7effc;"|
;Brief explanation: GTK2 and GST0.10 are end of life. We need to upgrade the remaining activities with these dependencies.
;Expected results: New versions of at least 25 existing Sugar activities.
;Knowledge prerequisites: Knowledge of GTK, GST, and Python

|-
| valign=top width="15%" style="background:#fcfcfc;" |Sugar Labs Social [[File:Social Site.jpg|90px|thumb|center]]
| valign=top width="15%" style="background:#fcfcfc;"| Jaskirat Singh Samson Goddy Hrishi Patel Shivang Shekhar perriefidelis
Abdulazeez Abdulazeez
| align=left valign=top style="background:#fcfcfc;"|
;Brief explanation: '''[https://github.com/geekrypter/Sugar-Labs-Social Sugar Labs Social]''' is a website project which should serve a purpose to help people understand and discuss project(s) around Sugar Labs. The goal of this project is to attract Teachers, Parents, Developers and fully communicate together in one platform. : It's a social website that can be used to attract maximum users and everything ( Blogs, New projects, Software, Activities, etc) can be uploaded on it which will attract more user and create their interest. : A competitive proposal must include some evidence that the approach taken will result in some use -- just because we build it doesn't mean they will come.
;Expected results: It should have user logins, feed and a blog([https://medium.com/ medium] like) that can be over viewed by people around the world
;Knowledge prerequisites: Good Layout designing and coding experience with backend (Django, JavaScript, HTML/CSS, Mongo).

|-
| valign=top width="15%" style="background:#f7effc;" |Lilypond Methodical Improvements to how Music Blocks generates Lilypond output [[File:Music-Blocks.png|90px|thumb|center]]
| valign=top width="15%" | Walter Bender Devin Ulibarri Marnen Laibow-Koser
| align=left valign=top |
;Brief explanation: Music Blocks is capable of exporting [https://www.lilypond.org Lilypond] code of which general instructions can be found [https://github.com/walterbender/musicblocks/tree/master/guide#BEYOND-MUSIC-BLOCKS here in the Music Blocks guide] and its [https://github.com/walterbender/musicblocks/ source code can be found here]. We would like to improve existing code where needed and implement needed features in a methodical way, which means we must 1) document how the Music Blocks source code works for current and future developers to learn and benefit from and 2) project manage this portion of Music Blocks development (e.g. "what works" and "what needs to be done". [https://owncloud.libretools.com/index.php/s/tgJAX5yMEzQsENf An example of a draft of a simple type of this analysis exists for you to start from.]), as well as 3) implement and improve features.
;Expected results: Implement and improve lilypond export features; Detailed documentation created for developer audience that details how Music Blocks exports to Lilypond; documentation to help manage what needs to be completed.
;Knowledge prerequisites: Literacy in reading music; functional knowledge of Lilypond code (some of your own scores would be nice); Organizational and Project Management Skills; JavaScript

|-
| valign=top width="15%" style="background:#fcfcfc;"|Music Blocks' First Steps for Robotics [[File:Music-Blocks.png|90px|thumb|center]]
| valign=top width="15%" style="background:#fcfcfc;"| Walter Bender Devin Ulibarri Hrishi Patel Rishabh Thaney
| align=left valign=top style="background:#fcfcfc;"|
;Brief explanation: What is needed to integrate Music Blocks with Robotics? This project is 1) to experiment with existing technologies to see what is already possible, 2) develop features (e.g. plugins, hardware modifications) needed to make interfacing possible, and 3) document the entire process and next steps
;Expected results: A working method for interfacing with a simple robot; additional features within MB to ease interfacing; and full documentation of how to recreate successful projects (that a classroom could use); communication (we do not want to guess what experiments you are doing by yourself--do not be shy to send emails, videos, pictures DAILY!!!)
;Knowledge prerequisites: Understanding of JavaScript (Music Blocks source code) and robotics (no particular method requested, just make sure it is free/libre); demonstrable documentation and self-management skills; NOTE: we value quality, clear ideas over expensive or pretty robots

|-
| valign=top width="15%" style="background:#f7effc;" |Create Examples, Compositions, and New Experiments Every Day! [[File:Music-Blocks.png|90px|thumb|center]]
| valign=top width="15%" | Walter Bender Devin Ulibarri Sachiko Nakajima
| align=left valign=top |
;Brief explanation: [https://walterbender.github.io/musicblocks/ Music Blocks] has some examples already, but it would be nice to have one ambitious student really work for the summer to make new creative, thoughtful code everyday. (You will be expected to code in the Music Blocks language on a daily basis.) Secondary, but important goals, are bug reports when bugs are found, feature suggestions, and overall good and frequent communication with the Music Blocks team.
;Expected results: Quality examples sent daily; variety of styles; runs entire gamut in terms of blocks used (we want a number of great examples for each and every block feature); organized documentation of all examples created, which can be finalized in the final weeks of GSoC
;Knowledge prerequisites: Understanding of Music Blocks as a programming language; A good proposal is one that has a well-thought out and detailed list of music projects for each day of GSoC (time-frames, blocks used, musical styles, name of music to be transcribed); experience with music and composition/theory is a definite plus.

|-
| valign=top width="15%" style="background:#fcfcfc;"|Music Blocks UI Improvements and Implementation [[File:Music-Blocks.png|90px|thumb|center]]
| valign=top width="15%" style="background:#fcfcfc;"| Walter Bender Devin Ulibarri Hrishi Patel Jaskirat Singh perriefidelis
| align=left valign=top style="background:#fcfcfc;"|
;Brief explanation: [https://walterbender.github.io/musicblocks/ Music Blocks] has a good enough UI, but there are open issues remaining and it would be nice if a person with a high level of understanding of graphics and style were to proposal and implement changes that unify the entire look and feel of Music Blocks.
;Expected results: Visually unified, beautiful and intuitive Music Blocks interface. Documentation to benefit future contributors to understand "what Music Blocks style is" (obviously this may change in the future, but a thoughtful rationale for the new style is expected).
;Knowledge prerequisites: Understanding of CSS, JavaScript, and HTML. Published work on UI (links to code, websites, etc)

|-
| valign=top width="15%" style="background:#f7effc;" |Scales/Modes/Keys Design Improvements and Implementation [[File:Music-Blocks.png|90px|thumb|center]]
| valign=top width="15%" | Walter Bender Devin Ulibarri Marnen Laibow-Koser Sachiko Nakajima perriefidelis Jaskirat Singh
| align=left valign=top |
;Brief explanation: There are features in [https://github.com/walterbender/musicblocks/tree/master/guide#3213-setting-voice-and-keys MB for exploring modes/scales/keys which can are referenced in the guide]. However, we suspect that there are better ways to organize keys. This project would be to reimagine how MB organizes pitches. We recommend that you read the discussions that have taken place already on GitHub as well as research how keys work as well as [https://owncloud.libretools.com/index.php/s/2GtAhkvQpt3fYfF scholarly articles about temperament, scales, and tuning]. Keep in mind that we would like to prepare for the possibility of chromatic pitch spaces that are not 12--for example, a chroma of 5 or 7 or 13, etc. What features and widgets are needed?
;Expected results: Detailed documentation created for developer audience that specifies 1) proposed features and overall design, 2) purpose of design choices, 3) audit of code (e.g. What changes to our current approach may be necessary? Are there libraries that may be useful?) 4) widget design proposal as well as MB code design proposal.
;Knowledge prerequisites: Understanding of Music Theory and/or group (or set) theory. Please read the articles at https://owncloud.libretools.com/index.php/s/2GtAhkvQpt3fYfF We are looking for candidates that can make a simple and effective design that can be implemented in JavaScript.

|-
| valign=top width="15%" style="background:#fcfcfc;"|Create UI features for music analysis and visualization [[File:Music-Blocks.png|90px|thumb|center]]
| valign=top width="15%" style="background:#fcfcfc;"| Walter Bender Devin Ulibarri Sachiko Nakajima perriefidelis
| align=left valign=top style="background:#fcfcfc;"|
;Brief explanation: Music Blocks does not yet have a robust set of tools to help the user analyze their music (e.g. highest pitch, lowest pitch, pitches used, keys, musical form, intervals etc.). Additionally, users would very much benefit from features to help them visualize the way their music is constructed. Perhaps we could even create some features to help the user choose a style of music and the analysis highlights movements that violate that style's particular rules.
;Expected results: New Features.
;Knowledge prerequisites: Literacy in reading music; Music Theory knowledge; UI knowledge; JavaScript knowledge

|-
| valign=top width="15%" style="background:#f7effc;" |Music Blocks Musical Ornaments Features [[File:Music-Blocks.png|90px|thumb|center]]
| valign=top width="15%" | Walter Bender Devin Ulibarri Sachiko Nakajima Marnen Laibow-Koser
| align=left valign=top |
;Brief explanation: The neighbor block feature is the first of a series of musical ornament features. There are many more possibilities, some of which are described [https://github.com/walterbender/musicblocks/issues/909 in issue 909]. The project would be to implement and document these features as well as to create example programs.
;Expected results: New Features, documentation, and new example programs for each new feature.
;Knowledge prerequisites: Music Theory knowledge; JavaScript knowledge; knowledge of Music Blocks and tone.js internals (please research)

|-
| valign=top width="15%" style="background:#fcfcfc;"|Music Blocks Widget Improvements [[File:Music-Blocks.png|90px|thumb|center]]
| valign=top width="15%" style="background:#fcfcfc;"| Walter Bender Devin Ulibarri Sachiko Nakajima Marnen Laibow-Koser
| align=left valign=top style="background:#fcfcfc;"|
;Brief explanation: Music Blocks has a number of features to help users conceptualize musical concepts, which also help to create code. Please see [https://github.com/walterbender/musicblocks/tree/master/guide#widgets the guide for more]. There are a number of widgets that have not been integrated at all as well. This project would be to 1) fix widget bugs, 2) implement unfinished features ([https://github.com/walterbender/musicblocks/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+widgets+ see issues]), and 3) document and fully integrate these new features and improve existing features. [https://github.com/walterbender/musicblocks/issues/663 is also a related feature]
;Expected results: New Features, fixes, documentation, and new example programs for each new feature.
;Knowledge prerequisites: Music Theory knowledge; JavaScript knowledge; knowledge of Music Blocks and tone.js internals (please research)

|-
|valign=top width="15%" style="background:#f7effc;" |Sugarizer School Box [[File:Sugarizerschoolbox.jpg|90px|thumb|center]]
|valign=top width="15%" |Michaël Ohayon Lionel Laské Hrishi Patel Rishabh Thaney
Shivang Shekhar
| align=left valign=top|
;Brief explanation
:[https://sugarizer.org Sugarizer] is the JavaScript version of Sugar, making education available of many platforms from web to mobile.:The app is composed by both a client side and a server side.
:The idea of this project is to develop a package to simplify deployment of Sugarizer in schools.
: This package will take two forms:
: 1 - An image for Raspberry Pi that could be flashed on a sd card that could automatically start a sugarizer server at boot and displays sugarizer client on the Pi. The server will be accessible by other devices from the local network. So the teacher has just to plug the RaspberryPI to expose a WiFi and the Sugarizer Server API/WebApp. So any computer connected to this WiFi could use Sugarizer Server WebApp and any tablet with Sugarizer App connected to this WiFi could benefit to collaboration, presence and backup its content on the server.
: 2 - Create one click to deploy scripts, to deploy a full Sugarizer stack on popular providers such as Amazon AWS or Heroku. So anyone could deploy a new Sugarizer Server instance on one of popular cloud platform without the need to dig into a complex setup process.
;Expected results:Raspberry Pi image files. Deployment scripts.
;Knowledge prerequisites:[https://github.com/llaske/sugarizer-server Sugarizer Server] knowledge, Linux system administration knowledge, bash scripting capabilities, Docker enthusiasm. (This project may require to download many system files)

|-
|valign=top width="15%" style="background:#fcfcfc;"|Sugarizer Exerciser activity [[File:Sugarizerexerciser.jpg|90px|thumb|center]]
|valign=top width="15%" style="background:#fcfcfc;"|Lionel Laské Michaël Ohayon Jaskirat Singh
| align=left valign=top style="background:#fcfcfc;"|
;Brief explanation
:[https://sugarizer.org Sugarizer] is the JavaScript version of Sugar, making education available of many platforms from web to mobile.
:The idea of this project is to create a new Sugarizer activity to allow users to create exercise and let other users play to this exercise.
:The activity will propose different templates for exercises. Typical exercises could be multiple-choice question, reordering a list of items, cloze text, group assignment, ...
:Once created, the exercise could be played locally or shared on the network using Sugarizer presence. At the end of the exercise a graph will give results for each participants.
:The activity should allow to integrate multimedia element (images, sounds, videos) coming from the Journal. The activity should as simple as possible so even a child should be able to create an exercise and share it.
:Like all Sugarizer activity, the activity should: adopt the Sugar UI, be responsive (work on any screen size), work with the keyboard and with the mouse (to support touch screen), use journal and use localization.
:Features inspiration could be found on [https://learningapps.org LearningApps], [https://www.google.com/forms/ Google Forms], [https://www.limesurvey.org LimeSurvey], ...
;Expected results:A Sugarizer activity.
;Knowledge prerequisites: HTML/JavaScript, UI Design, [https://github.com/llaske/sugarizer/blob/dev/docs/tutorial.md Sugarizer Development Tutorial]

|-
| valign=top width="15%" style="background:#f7effc;"|Music Blocks export [[File:Music-Blocks.png|90px|thumb|center]]
| valign=top width="15%" style="background:#f7effc"| Walter Bender Devin Ulibarri Sachiko Nakajima
| align="left" valign="top" style="background:#f7effc;" |
;Brief explanation: Music Blocks is essentially a Logo interpreter. It would be great to be able to export Logo from Music Blocks. (We need to find a Logo that can handle the basic synthesizer needs to make it relevant.)
;Expected results: A Logo export that is coupled to a music-enabled Logo interpreter.
;Knowledge prerequisites: Literacy in reading music; Music Theory knowledge; UI knowledge; Logo and JavaScript knowledge

|-
| valign=top width="15%" style="background:#fcfcfc;"|Music Blocks inline documentation [[File:Music-Blocks.png|90px|thumb|center]]
| valign=top width="15%" style="background:#fcfcfc"| Walter Bender Devin Ulibarri Sachiko Nakajima
| align=left valign=top style="background:#fcfcfc;"|
;Brief explanation: There are three types of documentation for Music Blocks: documentation about how individual blocks work; short coding examples; and lesson plans. This project is about the first two. We can add inline comments to each block as it is defined in basicblocks.js from which help can be autogenerated for each block. And we can utilize the "make block" mechanism to generate on-the-fly examples of how to use blocks in combination to achieve different musical goals. The former will require some JavaScript programming; the latter, Music Blocks programming.
;Expected results: In-line documentation for each block as well as in-line Music Blocks-coded examples of the core music ideas.
;Knowledge prerequisites: UI knowledge; JavaScript knowledge; some background in music.

|-
|valign=top width="15%" style="background:#f7effc;"|Making a Beginner Guide
| valign=top width="15%" style="background:#f7effc;"| Jaskirat Singh Hrishi Patel Rishabh Thaney Shivang Shekhar Samson Goddy Abdulazeez Abdulazeez
| align=left valign=top style="background:#f7effc;"|
;Brief explanation: We don't have a beginner guide for the newcomers to the Sugar labs Community. It would be great to guide them by guiding them how to contribute through making these "form where to start? , What to start? , How to start? , Where to submit? " . An example is the Coala [http://api.coala.io/en/latest/Developers/Newcomers_Guide.html Newcomers' Guide] which is built from [https://github.com/coala/coala/blob/6dae06082017587a260189a787db9cfdc84a148b/docs/Developers/Newcomers_Guide.rst markdown source]. The goal of this task is to Help newcomers to get introduce in easy way to the world of Sugar Labs also make a dasboard for the users so they can get about developed and developing areas. Their contribution can be seen also their presence can be seen with the community.
;Expected results: A set of website pages and also documentation in Pdf form with this the problems of newcomers about their contribution will be solved and they can work easily. It is essential to this project that there is a credible maintenance regime to ensure it is easy to keep it up to date after GSoC is completed.
;Knowledge prerequisites: HTML, CSS, JavaScript(interactive) , BootStrap(responsive nav compatible on mobile devices also), PHP(dashboard), Github workflow, Markdown/up for documentation.

|}
{| border="1" cellpadding="3" style="border: 1px solid white; border-collapse: collapse; background: #f7effc;"
|-
| valign="top" width="15%" style="background:#fcfcfc;" |Scratch 3.0 to Sugar Desktop [[File:Scratch.png|centre|thumb|99x99px]]
| valign="top" width="15%" style="background:#fcfcfc" | Walter Bender Samson Goddy
Hrishi Patel Ibiam Chihurumnaya
| align="left" valign="top" style="background:#fcfcfc;" |
;Brief explanation: [https://scratch.mit.edu/ Scratch] is a programming environment for kids. The goal of this project is to make bring back the [[Activities/Scratch|Scratch activity]] to the Sugar Desktop. Scratch 3.0 was created with HTML 5 using [https://developers.google.com/blockly/ Google’s blocky].
:# Port scratch 3.0 as a Sugar activity using method [https://github.com/sugarlabs/sugar-docs/blob/master/src/web-activity.md 1] or [https://github.com/walterbender/turtle-blocks-embedded-activity 2]. Method 1, a web activity that can run on the Sugar Desktop. While method 2, an embedded activity that can run inside browser activity. There have been some development of [https://github.com/EmilyOng/embedded-scratch-activity scratch to sugar] and a yet to release version of [https://github.com/EmilyOng/Scratch.activity scratch in Sugarizer].
:# Make the scratch libraries to work completely offline, so a user can import sprite without have issues of internet connection. A possible way is to fork the [https://github.com/LLK/scratch-storage scratch-storage] and [https://github.com/LLK/scratch-gui scratch-gui] modules to make them work offline by linking the libraries to local assets on the filesystem. https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API/Using_Service_Workers https://hackernoon.com/service-worker-one-fallback-offline-image-for-any-aspect-ratio-b427c0f897fb
;Expected results: A stable working Scratch 3 on Sugar Desktop.: User to "save project" within the scratch activity into the journal, making it easy to resume project.
: Make the Scratch activity work completely offline stated at 2.
;Knowledge prerequisites: Python, GTK, JavaScript knowledge
|}
{| border="1" cellpadding="3" style="border: 1px solid white; border-collapse: collapse; background: #f7effc;"
|-
| valign="top" width="15%" style="background:#f7effc;" |Sugarizer Primero (Sugarizer1°)
| valign="top" width="15%" style="background:#f7effc;" | Caryl Bigenho
Samson Goddy
| align="left" valign="top" style="background:#f7effc;" |
;Brief explanation: Sugarizer is a large collection of many Activities suitable for general audiences on many devices. The goal of this project is to package a subset of the Sugarizer Activities (Maximum of 5) for children 4-7 (grades Pre-K-2) with a young child-friendly UI/UX experience suitable devices. Many of the graphics in the interfaces will be re-designed to accommodate non-readers and very young children who are still developing their fine motor skills. One new Activity for intuitive math concepts will also be developed similar to [https://en.wikipedia.org/wiki/Cuisenaire_rods Cuisenaire Rods]. Sugarizer1° will be non-language dependent so translations will not be needed.
;Expected results: At the end of the summer project, a prototype of Sugarizer1° will be ready for beta testing by children, parents, and educators. .
;Knowledge prerequisites: Javascript, HTML, CSS and some knowledge of layout and design. A familiarity of how young children play and learn will also be helpful.

|}

Features/GTK3/Porting

2018-04-06T17:15:42Z

Pro-panda:

=Porting an existing activity to GTK+ 3=
This is a guide to porting an existing activity from GTK+ 2 to [http://developer.gnome.org/gtk3/stable/ GTK+ 3]. It also shows the changes to use the new Sugar toolkit that also now uses [[Features/GTK3|GTK+ 3]]. This guide uses the [https://github.com/sugarlabs/hello-world hello-world] activity as a simple example.

Here are some instances of porting activities, for reference:
* [https://github.com/sugarlabs/biorhythm/commit/c16de3b70cce2cc6f8af933e2b062c844a47c144/ Biorhythm]
* [https://github.com/sugarlabs/peru-learns-english-activity/commit/caa2cde526b3823a5a1f7d200a76ad5bc3502b0e Peru Learns English, includes GStreamer and GST update]
* [https://github.com/sugarlabs/jump/commit/b75410d2879d9829df942726f5465b7cf5a9d98d Port of Jump Activity]
* [https://github.com/sugarlabs/iknowMadagascar/commit/44ba42645ac4fcd9e06b4add7fa3b6ce2e0d9c3d Port of I-know-Madagascar]

=Steps to Port an Activity to GTK+ 3=
#Read the [http://wiki.sugarlabs.org/go/Features/GTK3 Sugar Official Wiki]
#Resolve any existing pull requests before porting to avoid conflicts at a later stage.
#Run this [http://git.gnome.org/browse/pygobject/tree/pygi-convert.sh script] that will convert automatically things as much as it can. This is to avoid some stressful manually conversions that a "simple script" can do using ''sed'' :)
#Follow the [[Development Team/Code guidelines|Code Guidelines]] during all the porting process
#Make the API changes in sugar-toolkit-gtk3
#Write comments on the code, by adding '''# README:''', '''# TODO:''' and '''# FIXME:''' explaining what are the problems that you are having with that chunk of code. Put a link if it's necessary

==API changes in sugar-toolkit ==
* The namespace is changed from <code>sugar</code> to <code>sugar3</code>, trying to reflect that GTK+ 3 is the underlying technology.
* The keep button has been removed
* The old-style toolbar has been removed
*<code>set_toolbar_box</code> is used instead of <code>set_toolbox</code> (see in [http://git.sugarlabs.org/~walter/abacus/walter-cairo/commit/6871dd340a89ade3b5361457e1bd1d58276a8efc Abacus])
* Remove import of deprecated ActivityToolbox (see [http://git.sugarlabs.org/hello-world/mainline/commit/22060a3063b2d6fd38d6b1cd8d44946170255af3 hello-world])
* Support for <code>service_name</code> and <code>class</code> tags in activity.info has been removed. Use <code>bundle_id</code> instead of <code>service_name</code> and <code>exec</code> instead of <code>class</code> (see in [http://git.sugarlabs.org/record/mainline/commit/6e8968c71e474e2d8d86886badf5cf7d70217dc5 Record])
* <code>sugar3.activity.Activity</code> does not have the ''window'' attribute. Use the <code>.get_window()</code> method instead.

==Port the activity from GTK+ 2 to GTK+ 3==
To start, change the importing instruction for GTK from
import gtk
to
import gi
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk

Note that <code>require_version</code> needs to called only the first time when GTK is being imported.

Similar imports that may be used are:
<pre>
from gi.repository import Gdk, Pango, Gobject
</pre>

Then you have to change each call that involves GTK, for example creating a button will look now like this:
button = Gtk.Button()

A simple hello world program in GTK+ 3 looks like this:
<pre>
from gi.repository import Gtk

def _destroy_cb(widget, data=None):
Gtk.main_quit()

w = Gtk.Window()
w.connect("destroy", _destroy_cb)
label = Gtk.Label('Hello World!')
w.add(label)
w.show_all()

Gtk.main()
</pre>

The changes that were needed to port the hello-world activity can be seen in [https://github.com/sugarlabs/hello-world/commit/508e1c518b56cbde5508e560c8a2ff38a3518583 this commit.]
====Simple example on creating a toolbar====
One of Sugar's activity most unique user interface includes the toolbar. In order to reference the relevant modules and graphics, the sugar3 library has to be imported. These are the relevant ones that would enable us to create a simple toolbar containing the activity button and the stop button.
<pre>
from sugar3.activity import activity
from sugar3.graphics.toolbarbox import ToolbarBox
from sugar3.activity.widgets import ActivityToolbarButton
from sugar3.activity.widgets import StopButton
from sugar3.graphics.toolbarbox import ToolbarButton
from sugar3.graphics import style
</pre>

Since the ActivityToolbar() module has been deprecated, the toolbar can now be called using
ToolbarBox()
Then, from the ToolbarBox(), include the ActivityButton and StopButton. In order for the StopButton to be align to the right as per Sugar activity interface, a separator has to be included as well.

<pre>
toolbar_box = ToolbarBox()

activity_button = ActivityToolbarButton(self)
toolbar_box.toolbar.insert(activity_button, 0)
activity_button.show()

separator = Gtk.SeparatorToolItem()
separator.props.draw = False
separator.set_expand(True)
toolbar_box.toolbar.insert(separator, -1)
separator.show()

stop_button = StopButton(self)
toolbar_box.toolbar.insert(stop_button, -1)
stop_button.show()
self.set_toolbar_box(toolbar_box)
toolbar_box.show()
</pre>

===Tools===
There are tools to help you do the porting. There is a script in the pygobject repository for porting called [http://git.gnome.org/browse/pygobject/tree/pygi-convert.sh pygi-convert.sh], more info about the script can be found in [http://live.gnome.org/PyGObject/IntrospectionPorting the PyGObject Introspection Porting guide].

Here is a script to automate the rename of the imports '''sugar''' to '''sugar3''': [http://dev.laptop.org/~manuq/sugar-convert.sh sugar-convert.sh].

If you are having trouble finding how a particular GTK class/method/constant has been named in PyGI, run [http://dev.laptop.org/~dsd/20110806/pygi-enumerate.py pygi-enumerate.py] and grep the output. (this app lists all identified methods and constants). Usage example:

<pre>
$ python pygi-enumerate.py | grep get_selection
Gtk.AccelLabel.get_selection_bounds() (instance method)
Gtk.Editable.get_selection_bounds() (instance method)
Gtk.Entry.get_selection_bounds() (instance method)
Gtk.IconView.get_selection_mode() (instance method)
Gtk.Label.get_selection_bounds() (instance method)
Gtk.SelectionData.get_selection() (instance method)
Gtk.SpinButton.get_selection_bounds() (instance method)
Gtk.TextBuffer.get_selection_bound() (instance method)
Gtk.TextBuffer.get_selection_bounds() (instance method)
Gtk.TreeView.get_selection() (instance method)
</pre>

=== Constructor considerations ===

With PyGI it is possible to use Python-like constructors, or "new" functions e.g. the following are (usually) equivalent:
label = Gtk.Button()
label = Gtk.Button.new()

However, the first form is preferred: it is more Python-like. Internally, the difference is that Gtk.Label.new() translates to a call to gtk_label_new(), whereas Gtk.Label() (the preferred form) will directly construct an instance of GtkLabel at the GObject level.

If the constructor takes parameters, they '''must''' be named. The parameters correspond to GObject properties in the API documentation which are usually marked as "Construct". For example, the following code will not work:

expander = Gtk.Expander("my expander")

The (confusing) error is:
TypeError: GObject.__init__() takes exactly 0 arguments (1 given)

The solution is to go to the [http://developer.gnome.org/gtk3/3.2/GtkExpander.html#GtkExpander.properties GtkExpander API documentation] and find the appropriate property that we wish to set. In this case it is label (which is a Construct property, further increasing our confidence of success), so the code should be:

expander = Gtk.Expander(label="my expander")

Combining the two points above, if you wish to call a construct-like function such as gtk_button_new_with_label(), you do have the option of calling Gtk.Button.new_with_label(), however if we check the [http://developer.gnome.org/gtk3/3.2/GtkButton.html#GtkButton.properties GtkButton properties] we see one called "label" which is equivalent. Therefore gtk_button_new_with_label("foo") should be called as:
button = Gtk.Button(label="foo")

=== HBox, VBox, pack_start and pack_end ===

GtkHBox and GtkVBox, commonly used containers in GTK+ 2 code, have pack_start and pack_end methods. These take 4 parameters:
# The widget to pack into the container
# '''expand''': Whether the child should receive extra space when the container grows (default True)
# '''fill''': True if space given to child by the expand option is actually allocated to child, rather than just padding it. This parameter has no effect if expand is set to False. A child is always allocated the full height of a gtk.HBox and the full width of a gtk.VBox. This option affects the other dimension. (default True)
# '''padding''': extra space in pixels to put between child and its neighbor (default 0)

In PyGTK, the expand, fill and padding parameters were optional: if unspecified, the default values above were used. In PyGI, these parameters are '''not''' optional: all 4 must be specified. Hence the rules for adding in the extra parameters are:

# If '''expand''' was not set, use value True
# If '''fill''' was not set, use value True. (however, if expand is False, this parameter gets ignored so False is an equally acceptable option when expand=False)
# If '''padding''' was not set, use value 0.

These parameters can be specified either as positional arguments or as named keyword arguments, however all 4 must always be specified. Some developers prefer keyword arguments, arguing that the following:
<pre>box.pack_start(widget, expand=True, fill=False, padding=4)</pre>
is much more readable than:
<pre>box.pack_start(widget, True, False, 4)</pre>

However, these functions are called extremely often; any mildly seasoned GTK developer will have memorized the order and meaning of the parameters. Some developers therefore prefer to avoid the extra work of dropping in hundreds of keyword arguments throughout the code and just use the positional ones. This is really up to you.

If you are using pack_start with the default values (expand=True, fill=True and padding=0), you can avoid using pack_start (and the parameter pain that it brings with it) by just using .add for some added cleanliness, e.g.
<pre>box.pack_start(widget, True, True, 0)</pre>
can be replaced with:
<pre>box.add(widget)</pre>

This is as far as you need to go for now. However, in GTK+ 3, GtkVBox and GtkHBox have been deprecated, which means they might be removed in GTK+ 3. The replacement is to use GtkBox directly, and you may wish to make this change now. e.g.:
<pre>vbox = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)</pre>
<pre>hbox = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL, homogeneous=True, spacing=8)</pre>
However, it must be noted that if GtkBox is used directly (instead of using GtkHBox/GtkVBox), the default value of '''expand''' is now '''False'''. The implications of this are:
# You need to check your .add() calls, as previously they would behave as pack_start with expand=True, but now they will behave as expand=False (you need to change them to use pack_start with expand=True to retain the old behaviour)
# Every single pack_start call that has expand=False and padding=0 (and any value of fill) can be converted to .add() for cleanliness

=== GtkAlignment considerations ===

In PyGTK, the gtk.Alignment constructor takes four optional parameters:
# xalign: the fraction of horizontal free space to the left of the child widget. Ranges from 0.0 to 1.0. Default value 0.0.
# yalign: the fraction of vertical free space above the child widget. Ranges from 0.0 to 1.0. Default value 0.0.
# xscale: the fraction of horizontal free space that the child widget absorbs, from 0.0 to 1.0. Default value 0.0.
# yscale: the fraction of vertical free space that the child widget absorbs, from 0.0 to 1.0. Default value 0.0

In PyGI/GTK3, these parameters are still optional when used in the Gtk.Alignment constructor (as keyword arguments, as explained above). However, the default values have changed. They are now:
# xalign: default value 0.5
# yalign: default value 0.5
# xscale: default value 1
# yscale: default value 1

If your code was relying on the default value of 0 for any of these parameters in PyGTK, you will now need to explicitly specify that in your constructor. Similarly, if you were previously using construction parameters to select the now-default values, those parameters can be dropped.

Additionally, PyGTK accepted these construction parameters as positional arguments. As explained above, they must now be converted to keyword arguments.

=== Gtk Menu Popup ===
The Gtk.Menu.popup function now works slightly differently.
The user supplied positioning function now takes different parameters. These are menu, x, y, push_in and user_data.
=== Gdk ===
Previously, gdk was an attribute of the GTK module, which means that it can be called through GTK. For example, if we want to use color_parse():
gtk.gdk.color_parse(color)
However, what we have to do now is:
from gi.repository import Gdk
Then we can modify the code to the following:
Gdk.color_parse(color)

=== Pango ===
Following the release of GTK+ 3, we should not be importing pango like this:
import pango
In fact, we can now import pango as an attribute within the GTK+ 3 library:
from gi.repository import Pango as pango
=== Gio.Settings from GConf ===
Any use of GConf should be ported to Gio.Settings.

=== Other considerations ===

''self.allocation'' property is no longer available. Please search your code for "self.allocation" and replace it for "self.get_allocation()".

So to get the allocation size:

self.allocation.width
self.allocation.height

should be replaced by:

self.get_allocated_width()
self.get_allocated_height()

=== Constants ===

Most of the constants have slightly different formats, e.g.,

gtk.STATE_NORMAL became Gtk.StateFlags.NORMAL
gtk.RESPONSE_ACCEPT became Gtk.ResponseType.ACCEPT
gtk.JUSTIFY_CENTER became Gtk.Justification.CENTER
gtk.RELIEF_NONE became Gtk.ReliefStyle.NONE

=== Pixbufs ===

The pixbuf libraies are in their own repository

from gi.repository import GdkPixbuf

GdkPixbuf.Pixbuf.new_from_file()

===Changes to the Clipboard===
Two things to note:

1. You need to specify a clipboard using get()
clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)
2. You need to pass a length to set_text()
clipboard.set_text(string, len(string))

See [http://python-gtk-3-tutorial.readthedocs.org/en/latest/clipboard.html] for more details.

===Changes to Drag-and-Drop===
Slightly different syntax:
self.drag_dest_set(Gtk.DestDefaults.ALL, [],
Gdk.DragAction.COPY)
self.drag_dest_set_target_list(Gtk.TargetList.new([]))
self.drag_dest_add_text_targets()
self.connect('drag_data_received', self._drag_data_received)

and:
data.get_text()
or:
data.get_image()

See [http://python-gtk-3-tutorial.readthedocs.org/en/latest/drag_and_drop.html] for more details.

===Going from Drawable to Cairo===

GTK+ 3 does not support GTK Drawable objects, so the first step is to get your activity running under Cairo.

<pre>
import cairo

# From activity.Activity, you inherit a canvas.
# Create a Cairo context from the window.
cairo_context = self.canvas.get_window().cairo_create()

# Create an XLib surface to be used for drawing
xlib_surface = surface.create_similar(cairo.CONTENT_COLOR,
gtk.gdk.screen_width(),
gtk.gdk.screen_height())

# You'll need a Cairo context from which you'll build a GTK Cairo context
cairo_context = cairo.Context(xlib_surface)
cairo_context = gtk.gdk.CairoContext(cairo_context)

# Use this context as you would a Drawable, substituting Cairo commands
# for gtk commands, e.g.,
cairo_context.move_to(0, 0)
cairo_context.line_to(100, 100)
# Cairo uses floats from 0 to 1 for RGB values
cairo_context.set_source_rgb(r, g, b)
cairo_context.rectangle(x, y, w, h)
cairo_context.fill()

# To invalidate a region to force a refresh, use:
self.canvas.queue_draw_area(x, y, w, h)

# Handle the expose event
# "expose" became "draw" for the cairo signal
def do_expose_event(self, event):
# Create the cairo context
cairo_context = self.canvas.get_window().cairo_create()
cairo_context.rectangle(event.area.x, event.area.y,
event.area.width, event.area.height)
cairo_context.clip()
cairo_context.set_source_surface(xlib_surface)
cairo_context.paint()
</pre>

Pango is a bit different when used with Cairo:

<pre>
import pango, pangocairo

# Again, from the xlib_surface...
cairo_context = cairo.Context(xlib_surface)

# Create a PangoCairo context
cairo_context = pangocairo.CairoContext(cairo_context)

# The pango layout is created from the Cairo context
pango_layout = cairo_context.create_layout()

# You still use pango to set up font descriptions.
fd = pango.FontDescription('Sans')
fd.set_size(12 * pango.SCALE)

# Tell your pango layout about your font description
pango_layout.set_font_description(fd)

# Write text to your pango layout
pango_layout.set_text('Hello world', -1)

# Position it within the Cairo context
cairo_context.save()
cairo_context.translate(x, y)
cairo_context.rotate(pi / 3) # You can rotate text and images in Cairo
cairo_context.set_source_rgb(1, 0, 0)

# Finally, draw the text
cairo_context.update_layout(pango_layout)
cairo_context.show_layout(pango_layout)
cairo_context.restore()
</pre>

To draw a bitmap...

<pre>
# Again, from the xlib_surface...
cairo_context = cairo.Context(xlib_surface)

# Create a gtk context
cairo_context = gtk.gdk.CairoContext(cairo_context)
cairo_context.set_source_pixbuf(pixbuf, x, y)
cairo_context.rectangle(x, y, w, h)
cairo_context.fill()
</pre>

To read a pixel from the xlib surface...

<pre>
# create a new 1x1 cairo surface
cairo_surface = cairo.ImageSurface(cairo.FORMAT_RGB24, 1, 1);
cairo_context = cairo.Context(cairo_surface)
# translate xlib_surface so that target pixel is at 0, 0
cairo_context.set_source_surface(xlib_surface, -x, -y)
cairo_context.rectangle(0,0,1,1)
cairo_context.set_operator(cairo.OPERATOR_SOURCE)
cairo_context.fill()
cairo_surface.flush() # ensure all writing is done
# Read the pixel
return (ord(pixels[2]), ord(pixels[1]), ord(pixels[0]), 0)
</pre>

===Going from Cairo in GTK-2 to Cairo in GTK-3===

(For more detailes, see http://developer.gnome.org/pangomm/2.28/annotated.html)

The Cairo/Pango interaction is a little different:
<pre>
from gi.repository import Pango, PangoCairo

cairo_context = ...
pango_layout = PangoCairo.create_layout(cairo_context)
fd = Pango.FontDescription('Sans')
fd.set_size(12 * Pango.SCALE)
pango_layout.set_font_description(fd)
pango_layout.set_text('Hello World', -1)
cairo_context.set_source_rgb(1, 0, 0)
PangoCairo.update_layout(cairo_context, pango_layout)
PangoCairo.show_layout(cairo_context, pango_layout)
</pre>

The get_extents() method if different in PangoCairo. It calculates an extent as a Rectangle, but doesn't return anything. There is a method, get_logical_extents() that returns a Rectangle. Alas, it is not necessarily available after v1.16. Note that Rectangle is not a list but a class with methods for get_x(), get_y(), get_width(), and get_height(), so you cannot iter over it.

Note that the <samp>cairo.Region</samp> will no longer work in GTK+3

==== Replacing pixmaps with Cairo ====
You need to replace your pixmaps with Cairo in GTK+ 3. For an example on how this is done, see: http://developer.gnome.org/gtk3/3.5/ch24s02.html#idp129615008

===Taking a screenshot and making a thumbnail===
To make a screenshot of the window:
<pre>
width, height = window.get_width(), window.get_height()
thumb_surface = Gdk.Window.create_similar_surface(window,
cairo.CONTENT_COLOR,
width, height)

thumb_width, thumb_height = style.zoom(100), style.zoom(80)
cairo_context = cairo.Context(thumb_surface)
thumb_scale_w = thumb_width * 1.0 / width
thumb_scale_h = thumb_height * 1.0 / height
cairo_context.scale(thumb_scale_w, thumb_scale_h)
Gdk.cairo_set_source_window(cairo_context, window, 0, 0)
cairo_context.paint()
thumb_surface.write_to_png(png_path_or_filelike_object)
</pre>

===Creating a video widget===

Some necessary changes include:

Using
get_property('window').get_xid()

Instead of
window.xid
Using
set_double_buffered(False)
set_app_paintable(True)
Instead of
unset_flags(gtk.DOUBLE_BUFFERED)
set_flags(gtk.APP_PAINTABLE)

=Hacks to help in porting=

=== Use the same keyboard and mouse ===
If you have an XO, I'm sure you want to take a look at [[User:Humitos/x2x|this]]...
===Use Extended Python debugger===
'''epdb''' library is useful to inspect the code while the Activity is running.
sudo yum install python-epdb
After that I put some trace point in the code where I can stop and make my tests by doing this:
import epdb;epdb.set_trace()
Finally I run Get Books Activity from the Terminal Activity to be able to write some code on a shell. This is the command that I use:
sugar-launch org.laptop.sugar.GetBooksActivity
See also [[Development Team/Debugging]].
===Check logs with ''multitail''===
Here is a really useful command to open new logs automatically: [[User:Humitos/MultiTail]]
===Use the pygobject code as example===
[https://live.gnome.org/PyGObject pygobject] is what we use to make Gtk3 activities. So, it's really useful to take a look at the code examples that are there. Even more, you can run some demo application that show how to use something specific about the library.
*Clone the code:
git clone git://git.gnome.org/pygobject
*Run an example
cd pygobject
cd demos/gtk-demo/demos
python pixbuf.py
*Grep the code to search for something useful
cd pygobject
git grep GdkPixbuf
===Monitoring DBus===
Not sure how this command works, but it can give us an interesting information. If you run this command and plug an USB drive you will see useful information
dbus-monitor --system

=Port to Python 3=
We are migrating towards Python 3. Python 3 does not support GTK+ 2. Hence, once the activity is ported to GTK+ 3, please consider porting the activity from Python 2 to Python 3.

Ref: [https://github.com/sugarlabs/sugar-docs/blob/master/src/python-porting-guide.md Guide to port activities to Python 3]

=Releasing activities (for maintainers)=
Once an activity is ported, a new release can be made. The major version should be greater than the existing one.

Please follow [https://github.com/sugarlabs/sugar-docs/blob/master/src/contributing.md#checklist---maintainer this] guide for releasing a new version

=Notes=
These are the changes implemented by developers while porting activities
*<code>Gtk.Widget.hide_all()</code> does not exist anymore. We should use just <code>.hide</code>
**Ref: http://developer.gnome.org/gtk3/3.5/GtkWidget.html#gtk-widget-hide

*If the code creates some own object, and it defines some properties, you should use '''__gproperties__''' dictionary: http://python-gtk-3-tutorial.readthedocs.org/en/latest/objects.html#GObject.GObject.__gproperties__
*<code>Gtk.ListStore</code> doesn't have the method '''.reorder'''. There is a [https://bugzilla.gnome.org/show_bug.cgi?id=677941 ticket] reported upstream about this.
*I replaced the use of <code>dbus</code> by [http://developer.gnome.org/gio/unstable/pt02.html Gio] to monitor the (dis)connection of pen drives
*Migrate custom signals:
**If you have defined custom gtk objects with custom signal you should migrate them to [http://python-gtk-3-tutorial.readthedocs.org/en/latest/objects.html the new way] to do this. You should replace this: from gobject import signal_new, TYPE_INT, TYPE_STRING, TYPE_BOOLEAN, \ TYPE_PYOBJECT, TYPE_NONE, SIGNAL_RUN_LAST signal_new('extlistview-modified', gtk.TreeView, SIGNAL_RUN_LAST, TYPE_NONE, ()) by adding the signal definition inside the object that you are creating using the <code>__gsignals__</code> dictionary like this (in this case Gtk.TreeView is the class that our object inherits): from gi.repository import GObject class ExtListView(Gtk.TreeView): __gsignals__ = { 'extlistview-modified': (GObject.SignalFlags.RUN_LAST, None, ()), } The last argument of the signal definition are the argument types that the callback will receive.
* Change the mouse cursor
** Example use case: When the activity is working and we want to show a ''work in progress'' cursor.
** Replace this:
self.window.set_cursor(gtk.gdk.Cursor(gtk.gdk.WATCH))
with:
from gi.repository import Gdk
self.get_window().set_cursor(Gdk.Cursor(Gdk.CursorType.WATCH))
=Resources=
*PyGI Documentation: https://lazka.github.io/pgi-docs/
*PYGTK documentation
**GTK+ 3: [http://python-gtk-3-tutorial.readthedocs.org/ http://python-gtk-3-tutorial.readthedocs.org]
**GTK+ 2: http://www.pygtk.org/docs/pygtk/
*Reference Manual
**GTK+ 3: http://developer.gnome.org/gtk3/3.4/
*Gdk documentation:
**Gdk3: http://developer.gnome.org/gdk/2.24/
*OLPC Documentation: http://wiki.laptop.org/go/Activities/PortingToGtk3
*Used to know the arguments of <code>GdkPixbuf.Pixbuf.save_to_bufferv</code> https://mail.gnome.org/archives/javascript-list/2011-March/msg00001.html

* Pango documentation: http://developer.gnome.org/pangomm

* Gst-1.0 documentation: http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/index.html

* Gst-1.0 porting hints: https://wiki.ubuntu.com/Novacut/GStreamer1.0
[[Category:Developer]]

= More porting examples =

{{Special:PrefixIndex/Features/GTK3/Porting}}

Features/GTK3/Porting

2018-04-06T14:01:44Z

Pro-panda: Standardise names, and remove redundancy

=Porting an existing activity to GTK+ 3=
This is a guide to porting an existing activity from GTK+ 2 to [http://developer.gnome.org/gtk3/stable/ GTK+ 3]. It also shows the changes to use the new Sugar toolkit that also now uses [[Features/GTK3|GTK+ 3]]. This guide uses the [https://github.com/sugarlabs/hello-world hello-world] activity as a simple example.

Here are some instances of porting activities, for reference:
* [https://github.com/sugarlabs/biorhythm/commit/c16de3b70cce2cc6f8af933e2b062c844a47c144/ Biorhythm]
* [https://github.com/sugarlabs/peru-learns-english-activity/commit/caa2cde526b3823a5a1f7d200a76ad5bc3502b0e Peru Learns English, includes GStreamer and GST update]
* [https://github.com/sugarlabs/jump/commit/b75410d2879d9829df942726f5465b7cf5a9d98d Port of Jump Activity]
* [https://github.com/sugarlabs/iknowMadagascar/commit/44ba42645ac4fcd9e06b4add7fa3b6ce2e0d9c3d Port of I-know-Madagascar]

=Steps to Port an Activity to GTK+ 3=
#Read the [http://wiki.sugarlabs.org/go/Features/GTK3 Sugar Official Wiki]
#Resolve any existing pull requests before porting to avoid conflicts at a later stage.
#Run this [http://git.gnome.org/browse/pygobject/tree/pygi-convert.sh script] that will convert automatically things as much as it can. This is to avoid some stressful manually conversions that a "simple script" can do using ''sed'' :)
#Follow the [[Development Team/Code guidelines|Code Guidelines]] during all the porting process
#Make the API changes in sugar-toolkit-gtk3
#Write comments on the code, by adding '''# README:''', '''# TODO:''' and '''# FIXME:''' explaining what are the problems that you are having with that chunk of code. Put a link if it's necessary

==API changes in sugar-toolkit ==
* The namespace is changed from <code>sugar</code> to <code>sugar3</code>, trying to reflect that GTK+ 3 is the underlying technology.
* The keep button has been removed
* The old-style toolbar has been removed
*<code>set_toolbar_box</code> is used instead of <code>set_toolbox</code> (see in [http://git.sugarlabs.org/~walter/abacus/walter-cairo/commit/6871dd340a89ade3b5361457e1bd1d58276a8efc Abacus])
* Remove import of deprecated ActivityToolbox (see [http://git.sugarlabs.org/hello-world/mainline/commit/22060a3063b2d6fd38d6b1cd8d44946170255af3 hello-world])
* Support for <code>service_name</code> and <code>class</code> tags in activity.info has been removed. Use <code>bundle_id</code> instead of <code>service_name</code> and <code>exec</code> instead of <code>class</code> (see in [http://git.sugarlabs.org/record/mainline/commit/6e8968c71e474e2d8d86886badf5cf7d70217dc5 Record])
* <code>sugar3.activity.Activity</code> does not have the ''window'' attribute. Use the <code>.get_window()</code> method instead.

==Port the activity from GTK+ 2 to GTK+ 3==
To start, change the importing instruction for GTK from
import gtk
to
import gi
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk

Note that <code>require_version</code> needs to called only the first time when GTK is being imported.

Similar imports that may be used are:
<pre>
from gi.repository import Gdk, Pango, Gobject
</pre>

Then you have to change each call that involves GTK, for example creating a button will look now like this:
button = Gtk.Button()

A simple hello world program in GTK+ 3 looks like this:
<pre>
from gi.repository import Gtk

def _destroy_cb(widget, data=None):
Gtk.main_quit()

w = Gtk.Window()
w.connect("destroy", _destroy_cb)
label = Gtk.Label('Hello World!')
w.add(label)
w.show_all()

Gtk.main()
</pre>

The changes that were needed to port the hello-world activity can be seen in [https://github.com/sugarlabs/hello-world/commit/508e1c518b56cbde5508e560c8a2ff38a3518583 this commit.]
====Simple example on creating a toolbar====
One of Sugar's activity most unique user interface includes the toolbar. In order to reference the relevant modules and graphics, the sugar3 library has to be imported. These are the relevant ones that would enable us to create a simple toolbar containing the activity button and the stop button.
<pre>
from sugar3.activity import activity
from sugar3.graphics.toolbarbox import ToolbarBox
from sugar3.activity.widgets import ActivityToolbarButton
from sugar3.activity.widgets import StopButton
from sugar3.graphics.toolbarbox import ToolbarButton
from sugar3.graphics import style
</pre>

Since the ActivityToolbar() module has been deprecated, the toolbar can now be called using
ToolbarBox()
Then, from the ToolbarBox(), include the ActivityButton and StopButton. In order for the StopButton to be align to the right as per Sugar activity interface, a separator has to be included as well.

<pre>
toolbar_box = ToolbarBox()

activity_button = ActivityToolbarButton(self)
toolbar_box.toolbar.insert(activity_button, 0)
activity_button.show()

separator = Gtk.SeparatorToolItem()
separator.props.draw = False
separator.set_expand(True)
toolbar_box.toolbar.insert(separator, -1)
separator.show()

stop_button = StopButton(self)
toolbar_box.toolbar.insert(stop_button, -1)
stop_button.show()
self.set_toolbar_box(toolbar_box)
toolbar_box.show()
</pre>

===Tools===
There are tools to help you do the porting. There is a script in the pygobject repository for porting called [http://git.gnome.org/browse/pygobject/tree/pygi-convert.sh pygi-convert.sh], more info about the script can be found in [http://live.gnome.org/PyGObject/IntrospectionPorting the PyGObject Introspection Porting guide].

Here is a script to automate the rename of the imports '''sugar''' to '''sugar3''': [http://dev.laptop.org/~manuq/sugar-convert.sh sugar-convert.sh].

If you are having trouble finding how a particular GTK class/method/constant has been named in PyGI, run [http://dev.laptop.org/~dsd/20110806/pygi-enumerate.py pygi-enumerate.py] and grep the output. (this app lists all identified methods and constants). Usage example:

<pre>
$ python pygi-enumerate.py | grep get_selection
Gtk.AccelLabel.get_selection_bounds() (instance method)
Gtk.Editable.get_selection_bounds() (instance method)
Gtk.Entry.get_selection_bounds() (instance method)
Gtk.IconView.get_selection_mode() (instance method)
Gtk.Label.get_selection_bounds() (instance method)
Gtk.SelectionData.get_selection() (instance method)
Gtk.SpinButton.get_selection_bounds() (instance method)
Gtk.TextBuffer.get_selection_bound() (instance method)
Gtk.TextBuffer.get_selection_bounds() (instance method)
Gtk.TreeView.get_selection() (instance method)
</pre>

=== Constructor considerations ===

With PyGI it is possible to use Python-like constructors, or "new" functions e.g. the following are (usually) equivalent:
label = Gtk.Button()
label = Gtk.Button.new()

However, the first form is preferred: it is more Python-like. Internally, the difference is that Gtk.Label.new() translates to a call to gtk_label_new(), whereas Gtk.Label() (the preferred form) will directly construct an instance of GtkLabel at the GObject level.

If the constructor takes parameters, they '''must''' be named. The parameters correspond to GObject properties in the API documentation which are usually marked as "Construct". For example, the following code will not work:

expander = Gtk.Expander("my expander")

The (confusing) error is:
TypeError: GObject.__init__() takes exactly 0 arguments (1 given)

The solution is to go to the [http://developer.gnome.org/gtk3/3.2/GtkExpander.html#GtkExpander.properties GtkExpander API documentation] and find the appropriate property that we wish to set. In this case it is label (which is a Construct property, further increasing our confidence of success), so the code should be:

expander = Gtk.Expander(label="my expander")

Combining the two points above, if you wish to call a construct-like function such as gtk_button_new_with_label(), you do have the option of calling Gtk.Button.new_with_label(), however if we check the [http://developer.gnome.org/gtk3/3.2/GtkButton.html#GtkButton.properties GtkButton properties] we see one called "label" which is equivalent. Therefore gtk_button_new_with_label("foo") should be called as:
button = Gtk.Button(label="foo")

=== HBox, VBox, pack_start and pack_end ===

GtkHBox and GtkVBox, commonly used containers in GTK+ 2 code, have pack_start and pack_end methods. These take 4 parameters:
# The widget to pack into the container
# '''expand''': Whether the child should receive extra space when the container grows (default True)
# '''fill''': True if space given to child by the expand option is actually allocated to child, rather than just padding it. This parameter has no effect if expand is set to False. A child is always allocated the full height of a gtk.HBox and the full width of a gtk.VBox. This option affects the other dimension. (default True)
# '''padding''': extra space in pixels to put between child and its neighbor (default 0)

In PyGTK, the expand, fill and padding parameters were optional: if unspecified, the default values above were used. In PyGI, these parameters are '''not''' optional: all 4 must be specified. Hence the rules for adding in the extra parameters are:

# If '''expand''' was not set, use value True
# If '''fill''' was not set, use value True. (however, if expand is False, this parameter gets ignored so False is an equally acceptable option when expand=False)
# If '''padding''' was not set, use value 0.

These parameters can be specified either as positional arguments or as named keyword arguments, however all 4 must always be specified. Some developers prefer keyword arguments, arguing that the following:
<pre>box.pack_start(widget, expand=True, fill=False, padding=4)</pre>
is much more readable than:
<pre>box.pack_start(widget, True, False, 4)</pre>

However, these functions are called extremely often; any mildly seasoned GTK developer will have memorized the order and meaning of the parameters. Some developers therefore prefer to avoid the extra work of dropping in hundreds of keyword arguments throughout the code and just use the positional ones. This is really up to you.

If you are using pack_start with the default values (expand=True, fill=True and padding=0), you can avoid using pack_start (and the parameter pain that it brings with it) by just using .add for some added cleanliness, e.g.
<pre>box.pack_start(widget, True, True, 0)</pre>
can be replaced with:
<pre>box.add(widget)</pre>

This is as far as you need to go for now. However, in GTK+ 3, GtkVBox and GtkHBox have been deprecated, which means they might be removed in GTK+ 3. The replacement is to use GtkBox directly, and you may wish to make this change now. e.g.:
<pre>vbox = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)</pre>
<pre>hbox = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL, homogeneous=True, spacing=8)</pre>
However, it must be noted that if GtkBox is used directly (instead of using GtkHBox/GtkVBox), the default value of '''expand''' is now '''False'''. The implications of this are:
# You need to check your .add() calls, as previously they would behave as pack_start with expand=True, but now they will behave as expand=False (you need to change them to use pack_start with expand=True to retain the old behaviour)
# Every single pack_start call that has expand=False and padding=0 (and any value of fill) can be converted to .add() for cleanliness

=== GtkAlignment considerations ===

In PyGTK, the gtk.Alignment constructor takes four optional parameters:
# xalign: the fraction of horizontal free space to the left of the child widget. Ranges from 0.0 to 1.0. Default value 0.0.
# yalign: the fraction of vertical free space above the child widget. Ranges from 0.0 to 1.0. Default value 0.0.
# xscale: the fraction of horizontal free space that the child widget absorbs, from 0.0 to 1.0. Default value 0.0.
# yscale: the fraction of vertical free space that the child widget absorbs, from 0.0 to 1.0. Default value 0.0

In PyGI/GTK3, these parameters are still optional when used in the Gtk.Alignment constructor (as keyword arguments, as explained above). However, the default values have changed. They are now:
# xalign: default value 0.5
# yalign: default value 0.5
# xscale: default value 1
# yscale: default value 1

If your code was relying on the default value of 0 for any of these parameters in PyGTK, you will now need to explicitly specify that in your constructor. Similarly, if you were previously using construction parameters to select the now-default values, those parameters can be dropped.

Additionally, PyGTK accepted these construction parameters as positional arguments. As explained above, they must now be converted to keyword arguments.

=== Gtk Menu Popup ===
The Gtk.Menu.popup function now works slightly differently.
The user supplied positioning function now takes different parameters. These are menu, x, y, push_in and user_data.
=== Gdk ===
Previously, gdk was an attribute of the GTK module, which means that it can be called through GTK. For example, if we want to use color_parse():
gtk.gdk.color_parse(color)
However, what we have to do now is:
from gi.repository import Gdk
Then we can modify the code to the following:
Gdk.color_parse(color)

=== Pango ===
Following the release of GTK+ 3, we should not be importing pango like this:
import pango
In fact, we can now import pango as an attribute within the GTK+ 3 library:
from gi.repository import Pango as pango
=== Gio.Settings from GConf ===
Any use of GConf should be ported to Gio.Settings.

=== Other considerations ===

''self.allocation'' property is no longer available. Please search your code for "self.allocation" and replace it for "self.get_allocation()".

So to get the allocation size:

self.allocation.width
self.allocation.height

should be replaced by:

self.get_allocated_width()
self.get_allocated_height()

=== Constants ===

Most of the constants have slightly different formats, e.g.,

gtk.STATE_NORMAL became Gtk.StateFlags.NORMAL
gtk.RESPONSE_ACCEPT became Gtk.ResponseType.ACCEPT
gtk.JUSTIFY_CENTER became Gtk.Justification.CENTER
gtk.RELIEF_NONE became Gtk.ReliefStyle.NONE

=== Pixbufs ===

The pixbuf libraies are in their own repository

from gi.repository import GdkPixbuf

GdkPixbuf.Pixbuf.new_from_file()

===Changes to the Clipboard===
Two things to note:

1. You need to specify a clipboard using get()
clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)
2. You need to pass a length to set_text()
clipboard.set_text(string, len(string))

See [http://python-gtk-3-tutorial.readthedocs.org/en/latest/clipboard.html] for more details.

===Changes to Drag-and-Drop===
Slightly different syntax:
self.drag_dest_set(Gtk.DestDefaults.ALL, [],
Gdk.DragAction.COPY)
self.drag_dest_set_target_list(Gtk.TargetList.new([]))
self.drag_dest_add_text_targets()
self.connect('drag_data_received', self._drag_data_received)

and:
data.get_text()
or:
data.get_image()

See [http://python-gtk-3-tutorial.readthedocs.org/en/latest/drag_and_drop.html] for more details.

===Going from Drawable to Cairo===

GTK+ 3 does not support GTK Drawable objects, so the first step is to get your activity running under Cairo.

<pre>
import cairo

# From activity.Activity, you inherit a canvas.
# Create a Cairo context from the window.
cairo_context = self.canvas.get_window().cairo_create()

# Create an XLib surface to be used for drawing
xlib_surface = surface.create_similar(cairo.CONTENT_COLOR,
gtk.gdk.screen_width(),
gtk.gdk.screen_height())

# You'll need a Cairo context from which you'll build a GTK Cairo context
cairo_context = cairo.Context(xlib_surface)
cairo_context = gtk.gdk.CairoContext(cairo_context)

# Use this context as you would a Drawable, substituting Cairo commands
# for gtk commands, e.g.,
cairo_context.move_to(0, 0)
cairo_context.line_to(100, 100)
# Cairo uses floats from 0 to 1 for RGB values
cairo_context.set_source_rgb(r, g, b)
cairo_context.rectangle(x, y, w, h)
cairo_context.fill()

# To invalidate a region to force a refresh, use:
self.canvas.queue_draw_area(x, y, w, h)

# Handle the expose event
# "expose" became "draw" for the cairo signal
def do_expose_event(self, event):
# Create the cairo context
cairo_context = self.canvas.get_window().cairo_create()
cairo_context.rectangle(event.area.x, event.area.y,
event.area.width, event.area.height)
cairo_context.clip()
cairo_context.set_source_surface(xlib_surface)
cairo_context.paint()
</pre>

Pango is a bit different when used with Cairo:

<pre>
import pango, pangocairo

# Again, from the xlib_surface...
cairo_context = cairo.Context(xlib_surface)

# Create a PangoCairo context
cairo_context = pangocairo.CairoContext(cairo_context)

# The pango layout is created from the Cairo context
pango_layout = cairo_context.create_layout()

# You still use pango to set up font descriptions.
fd = pango.FontDescription('Sans')
fd.set_size(12 * pango.SCALE)

# Tell your pango layout about your font description
pango_layout.set_font_description(fd)

# Write text to your pango layout
pango_layout.set_text('Hello world', -1)

# Position it within the Cairo context
cairo_context.save()
cairo_context.translate(x, y)
cairo_context.rotate(pi / 3) # You can rotate text and images in Cairo
cairo_context.set_source_rgb(1, 0, 0)

# Finally, draw the text
cairo_context.update_layout(pango_layout)
cairo_context.show_layout(pango_layout)
cairo_context.restore()
</pre>

To draw a bitmap...

<pre>
# Again, from the xlib_surface...
cairo_context = cairo.Context(xlib_surface)

# Create a gtk context
cairo_context = gtk.gdk.CairoContext(cairo_context)
cairo_context.set_source_pixbuf(pixbuf, x, y)
cairo_context.rectangle(x, y, w, h)
cairo_context.fill()
</pre>

To read a pixel from the xlib surface...

<pre>
# create a new 1x1 cairo surface
cairo_surface = cairo.ImageSurface(cairo.FORMAT_RGB24, 1, 1);
cairo_context = cairo.Context(cairo_surface)
# translate xlib_surface so that target pixel is at 0, 0
cairo_context.set_source_surface(xlib_surface, -x, -y)
cairo_context.rectangle(0,0,1,1)
cairo_context.set_operator(cairo.OPERATOR_SOURCE)
cairo_context.fill()
cairo_surface.flush() # ensure all writing is done
# Read the pixel
return (ord(pixels[2]), ord(pixels[1]), ord(pixels[0]), 0)
</pre>

===Going from Cairo in GTK-2 to Cairo in GTK-3===

(For more detailes, see http://developer.gnome.org/pangomm/2.28/annotated.html)

The Cairo/Pango interaction is a little different:
<pre>
from gi.repository import Pango, PangoCairo

cairo_context = ...
pango_layout = PangoCairo.create_layout(cairo_context)
fd = Pango.FontDescription('Sans')
fd.set_size(12 * Pango.SCALE)
pango_layout.set_font_description(fd)
pango_layout.set_text('Hello World', -1)
cairo_context.set_source_rgb(1, 0, 0)
PangoCairo.update_layout(cairo_context, pango_layout)
PangoCairo.show_layout(cairo_context, pango_layout)
</pre>

The get_extents() method if different in PangoCairo. It calculates an extent as a Rectangle, but doesn't return anything. There is a method, get_logical_extents() that returns a Rectangle. Alas, it is not necessarily available after v1.16. Note that Rectangle is not a list but a class with methods for get_x(), get_y(), get_width(), and get_height(), so you cannot iter over it.

Note that the <samp>cairo.Region</samp> will no longer work in GTK+3

==== Replacing pixmaps with Cairo ====
You need to replace your pixmaps with Cairo in GTK+ 3. For an example on how this is done, see: http://developer.gnome.org/gtk3/3.5/ch24s02.html#idp129615008

===Taking a screenshot and making a thumbnail===
To make a screenshot of the window:
<pre>
width, height = window.get_width(), window.get_height()
thumb_surface = Gdk.Window.create_similar_surface(window,
cairo.CONTENT_COLOR,
width, height)

thumb_width, thumb_height = style.zoom(100), style.zoom(80)
cairo_context = cairo.Context(thumb_surface)
thumb_scale_w = thumb_width * 1.0 / width
thumb_scale_h = thumb_height * 1.0 / height
cairo_context.scale(thumb_scale_w, thumb_scale_h)
Gdk.cairo_set_source_window(cairo_context, window, 0, 0)
cairo_context.paint()
thumb_surface.write_to_png(png_path_or_filelike_object)
</pre>

===Creating a video widget===

Some necessary changes include:

Using
get_property('window').get_xid()

Instead of
window.xid
Using
set_double_buffered(False)
set_app_paintable(True)
Instead of
unset_flags(gtk.DOUBLE_BUFFERED)
set_flags(gtk.APP_PAINTABLE)

=Hacks to help in porting=

=== Use the same keyboard and mouse ===
If you have an XO, I'm sure you want to take a look at [[User:Humitos/x2x|this]]...
===Use Extended Python debugger===
'''epdb''' library is useful to inspect the code while the Activity is running.
sudo yum install python-epdb
After that I put some trace point in the code where I can stop and make my tests by doing this:
import epdb;epdb.set_trace()
Finally I run Get Books Activity from the Terminal Activity to be able to write some code on a shell. This is the command that I use:
sugar-launch org.laptop.sugar.GetBooksActivity
See also [[Development Team/Debugging]].
===Check logs with ''multitail''===
Here is a really useful command to open new logs automatically: [[User:Humitos/MultiTail]]
===Use the pygobject code as example===
[https://live.gnome.org/PyGObject pygobject] is what we use to make Gtk3 activities. So, it's really useful to take a look at the code examples that are there. Even more, you can run some demo application that show how to use something specific about the library.
*Clone the code:
git clone git://git.gnome.org/pygobject
*Run an example
cd pygobject
cd demos/gtk-demo/demos
python pixbuf.py
*Grep the code to search for something useful
cd pygobject
git grep GdkPixbuf
===Monitoring DBus===
Not sure how this command works, but it can give us an interesting information. If you run this command and plug an USB drive you will see useful information
dbus-monitor --system

=Port to Python 3=
We are migrating towards Python 3. Python 3 does not support GTK+ 2. Hence, once the activity is ported to GTK+ 3, please consider porting the activity from Python 2 to Python 3.

Ref: [https://github.com/sugarlabs/sugar-docs/blob/master/src/python-porting-guide.md Guide to port activities to Python 3]

=Releasing activities (for maintainers)=
Once an activity is ported, a new release can be made. The major version should be greater than the existing one.

Please follow [https://github.com/sugarlabs/sugar-docs/blob/master/src/contributing.md#checklist---maintainer this] guide for releasing a new version

=Notes=
These are the changes implemented by developers while porting activities
*<code>Gtk.Widget.hide_all()</code> does not exist anymore. We should use just <code>.hide</code>
**Ref: http://developer.gnome.org/gtk3/3.5/GtkWidget.html#gtk-widget-hide

*If the code creates some own object, and it defines some properties, you should use '''__gproperties__''' dictionary: http://python-gtk-3-tutorial.readthedocs.org/en/latest/objects.html#GObject.GObject.__gproperties__
*<code>Gtk.ListStore</code> doesn't have the method '''.reorder'''. There is a [https://bugzilla.gnome.org/show_bug.cgi?id=677941 ticket] reported upstream about this.
*I replaced the use of <code>dbus</code> by [http://developer.gnome.org/gio/unstable/pt02.html Gio] to monitor the (dis)connection of pen drives
*Migrate custom signals:
**If you have defined custom gtk objects with custom signal you should migrate them to [http://python-gtk-3-tutorial.readthedocs.org/en/latest/objects.html the new way] to do this. You should replace this: from gobject import signal_new, TYPE_INT, TYPE_STRING, TYPE_BOOLEAN, \ TYPE_PYOBJECT, TYPE_NONE, SIGNAL_RUN_LAST signal_new('extlistview-modified', gtk.TreeView, SIGNAL_RUN_LAST, TYPE_NONE, ()) by adding the signal definition inside the object that you are creating using the <code>__gsignals__</code> dictionary like this (in this case Gtk.TreeView is the class that our object inherits): from gi.repository import GObject class ExtListView(Gtk.TreeView): __gsignals__ = { 'extlistview-modified': (GObject.SignalFlags.RUN_LAST, None, ()), } The last argument of the signal definition are the argument types that the callback will receive.
* Change the mouse cursor
** Example use case: When the activity is working and we want to show a ''work in progress'' cursor.
** Replace this:
self.window.set_cursor(gtk.gdk.Cursor(gtk.gdk.WATCH))
with:
from gi.repository import Gdk
self.get_window().set_cursor(Gdk.Cursor(Gdk.CursorType.WATCH))
=Resources=
*PyGI Documentation: https://lazka.github.io/pgi-docs/
*PYGTK documentation
**GTK+ 3: [http://python-gtk-3-tutorial.readthedocs.org/ http://python-gtk-3-tutorial.readthedocs.org]
**GTK+ 2: http://www.pygtk.org/docs/pygtk/
*Reference Manual
**GTK+ 3: http://developer.gnome.org/gtk3/3.4/
*Gdk documentation:
**Gdk3: http://developer.gnome.org/gdk/2.24/
*OLPC Documentation: http://wiki.laptop.org/go/Activities/PortingToGtk3
*Used to know the arguments of <code>GdkPixbuf.Pixbuf.save_to_bufferv</code> https://mail.gnome.org/archives/javascript-list/2011-March/msg00001.html

* Pango documentation: http://developer.gnome.org/pangomm

* Gst-1.0 documentation: http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/index.html

* Gst-1.0 porting hints: https://wiki.ubuntu.com/Novacut/GStreamer1.0
[[Category:Developer]]

= More porting wiki pages =

{{Special:PrefixIndex/Features/GTK3/Porting}}

Features/GTK3/Porting

2018-04-05T05:33:50Z

Pro-panda:

=Porting an existing activity to GTK3=
This is a guide to porting an existing activity from GTK2 to [http://developer.gnome.org/gtk3/stable/ GTK3]. It also shows the changes to use the new Sugar toolkit that also now uses [[Features/GTK3|GTK3]]. This guide uses the [https://github.com/sugarlabs/hello-world hello-world] activity as a simple example.

Here are some instances of porting activities, for reference:
* [https://github.com/sugarlabs/biorhythm/commit/c16de3b70cce2cc6f8af933e2b062c844a47c144/ Biorhythm]
* [https://github.com/sugarlabs/peru-learns-english-activity/commit/caa2cde526b3823a5a1f7d200a76ad5bc3502b0e Peru Learns English, includes GStreamer and GST update]
* [https://github.com/sugarlabs/jump/commit/b75410d2879d9829df942726f5465b7cf5a9d98d Port of Jump Activity]
* [https://github.com/sugarlabs/iknowMadagascar/commit/44ba42645ac4fcd9e06b4add7fa3b6ce2e0d9c3d Port of I-know-Madagascar]

=Steps to Port an Activity to Gtk3=
#Read the [http://wiki.sugarlabs.org/go/Features/GTK3 Sugar Official Wiki]
#Resolve any existing pull requests before porting to avoid conflicts at a later stage.
#Run this [http://git.gnome.org/browse/pygobject/tree/pygi-convert.sh script] that will convert automatically things as much as it can. This is to avoid some stressful manually conversions that a "simple script" can do using ''sed'' :)
#Follow the [[Development Team/Code guidelines|Code Guidelines]] during all the porting process
#Make the API changes in sugar-toolkit-gtk3
#Write comments on the code, by adding '''# README:''', '''# TODO:''' and '''# FIXME:''' explaining what are the problems that you are having with that chunk of code. Put a link if it's necessary

==API changes in sugar-toolkit ==
* The keep button has been removed
* The old-style toolbar has been removed
*<code>set_toolbar_box</code> is used instead of <code>set_toolbox</code> (see in [http://git.sugarlabs.org/~walter/abacus/walter-cairo/commit/6871dd340a89ade3b5361457e1bd1d58276a8efc Abacus])
* Remove import of deprecated ActivityToolbox (see [http://git.sugarlabs.org/hello-world/mainline/commit/22060a3063b2d6fd38d6b1cd8d44946170255af3 hello-world])
* Support for <code>service_name</code> and <code>class</code> tags in activity.info has been removed. Use <code>bundle_id</code> instead of <code>service_name</code> and <code>exec</code> instead of <code>class</code> (see in [http://git.sugarlabs.org/record/mainline/commit/6e8968c71e474e2d8d86886badf5cf7d70217dc5 Record])
* <code>sugar3.activity.Activity</code> does not have the ''window'' attribute. Use the <code>.get_window()</code> method instead.

==Port the activity from GTK2 to GTK3==
To start, change the importing instruction for GTK from
import gtk
to
import gi
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk

Note that <code>require_version</code> needs to called only the first time when Gtk is being imported.

Similar imports that may be used are:
<pre>
from gi.repository import Gdk, Pango, Gobject
</pre>

Then you have to change each call that involves Gtk, for example creating a button will look now like this:
button = Gtk.Button()

A simple hello world program in GTK3 looks like this:
<pre>
from gi.repository import Gtk

def _destroy_cb(widget, data=None):
Gtk.main_quit()

w = Gtk.Window()
w.connect("destroy", _destroy_cb)
label = Gtk.Label('Hello World!')
w.add(label)
w.show_all()

Gtk.main()
</pre>

For porting your activity you do have to change your calls for accessing widgets and services in the new GTK3 sugar-toolkit as well. The new namespace is called [https://developer.sugarlabs.org/sugar3/ sugar3], trying to reflect that GTK3 is the underlying technology. For example the import of the base activity class has to be changed from
from sugar.activity import activity
to
from sugar3.activity import activity

The changes that were needed to port the hello-world activity can be seen in [https://github.com/sugarlabs/hello-world/commit/508e1c518b56cbde5508e560c8a2ff38a3518583 this commit.]

====Simple example on creating a toolbar====
One of Sugar's activity most unique user interface includes the toolbar. In order to reference the relevant modules and graphics, the sugar3 library has to be imported. These are the relevant ones that would enable us to create a simple toolbar containing the activity button and the stop button.
<pre>
from sugar3.activity import activity
from sugar3.graphics.toolbarbox import ToolbarBox
from sugar3.activity.widgets import ActivityToolbarButton
from sugar3.activity.widgets import StopButton
from sugar3.graphics.toolbarbox import ToolbarButton
from sugar3.graphics import style
</pre>

Since the ActivityToolbar() module has been deprecated, the toolbar can now be called using
ToolbarBox()
Then, from the ToolbarBox(), include the ActivityButton and StopButton. In order for the StopButton to be align to the right as per Sugar activity interface, a separator has to be included as well.

<pre>
toolbar_box = ToolbarBox()

activity_button = ActivityToolbarButton(self)
toolbar_box.toolbar.insert(activity_button, 0)
activity_button.show()

separator = Gtk.SeparatorToolItem()
separator.props.draw = False
separator.set_expand(True)
toolbar_box.toolbar.insert(separator, -1)
separator.show()

stop_button = StopButton(self)
toolbar_box.toolbar.insert(stop_button, -1)
stop_button.show()
self.set_toolbar_box(toolbar_box)
toolbar_box.show()
</pre>

===Tools===
There are tools to help you do the porting. There is a script in the pygobject repository for porting called [http://git.gnome.org/browse/pygobject/tree/pygi-convert.sh pygi-convert.sh], more info about the script can be found in [http://live.gnome.org/PyGObject/IntrospectionPorting the PyGObject Introspection Porting guide].

Here is a script to automate the rename of the imports '''sugar''' to '''sugar3''': [http://dev.laptop.org/~manuq/sugar-convert.sh sugar-convert.sh].

If you are having trouble finding how a particular GTK class/method/constant has been named in PyGI, run [http://dev.laptop.org/~dsd/20110806/pygi-enumerate.py pygi-enumerate.py] and grep the output. (this app lists all identified methods and constants). Usage example:

<pre>
$ python pygi-enumerate.py | grep get_selection
Gtk.AccelLabel.get_selection_bounds() (instance method)
Gtk.Editable.get_selection_bounds() (instance method)
Gtk.Entry.get_selection_bounds() (instance method)
Gtk.IconView.get_selection_mode() (instance method)
Gtk.Label.get_selection_bounds() (instance method)
Gtk.SelectionData.get_selection() (instance method)
Gtk.SpinButton.get_selection_bounds() (instance method)
Gtk.TextBuffer.get_selection_bound() (instance method)
Gtk.TextBuffer.get_selection_bounds() (instance method)
Gtk.TreeView.get_selection() (instance method)
</pre>

=== Constructor considerations ===

With PyGI it is possible to use Python-like constructors, or "new" functions e.g. the following are (usually) equivalent:
label = Gtk.Button()
label = Gtk.Button.new()

However, the first form is preferred: it is more Python-like. Internally, the difference is that Gtk.Label.new() translates to a call to gtk_label_new(), whereas Gtk.Label() (the preferred form) will directly construct an instance of GtkLabel at the GObject level.

If the constructor takes parameters, they '''must''' be named. The parameters correspond to GObject properties in the API documentation which are usually marked as "Construct". For example, the following code will not work:

expander = Gtk.Expander("my expander")

The (confusing) error is:
TypeError: GObject.__init__() takes exactly 0 arguments (1 given)

The solution is to go to the [http://developer.gnome.org/gtk3/3.2/GtkExpander.html#GtkExpander.properties GtkExpander API documentation] and find the appropriate property that we wish to set. In this case it is label (which is a Construct property, further increasing our confidence of success), so the code should be:

expander = Gtk.Expander(label="my expander")

Combining the two points above, if you wish to call a construct-like function such as gtk_button_new_with_label(), you do have the option of calling Gtk.Button.new_with_label(), however if we check the [http://developer.gnome.org/gtk3/3.2/GtkButton.html#GtkButton.properties GtkButton properties] we see one called "label" which is equivalent. Therefore gtk_button_new_with_label("foo") should be called as:
button = Gtk.Button(label="foo")

=== HBox, VBox, pack_start and pack_end ===

GtkHBox and GtkVBox, commonly used containers in GTK2 code, have pack_start and pack_end methods. These take 4 parameters:
# The widget to pack into the container
# '''expand''': Whether the child should receive extra space when the container grows (default True)
# '''fill''': True if space given to child by the expand option is actually allocated to child, rather than just padding it. This parameter has no effect if expand is set to False. A child is always allocated the full height of a gtk.HBox and the full width of a gtk.VBox. This option affects the other dimension. (default True)
# '''padding''': extra space in pixels to put between child and its neighbor (default 0)

In PyGTK, the expand, fill and padding parameters were optional: if unspecified, the default values above were used. In PyGI, these parameters are '''not''' optional: all 4 must be specified. Hence the rules for adding in the extra parameters are:

# If '''expand''' was not set, use value True
# If '''fill''' was not set, use value True. (however, if expand is False, this parameter gets ignored so False is an equally acceptable option when expand=False)
# If '''padding''' was not set, use value 0.

These parameters can be specified either as positional arguments or as named keyword arguments, however all 4 must always be specified. Some developers prefer keyword arguments, arguing that the following:
<pre>box.pack_start(widget, expand=True, fill=False, padding=4)</pre>
is much more readable than:
<pre>box.pack_start(widget, True, False, 4)</pre>

However, these functions are called extremely often; any mildly seasoned GTK developer will have memorized the order and meaning of the parameters. Some developers therefore prefer to avoid the extra work of dropping in hundreds of keyword arguments throughout the code and just use the positional ones. This is really up to you.

If you are using pack_start with the default values (expand=True, fill=True and padding=0), you can avoid using pack_start (and the parameter pain that it brings with it) by just using .add for some added cleanliness, e.g.
<pre>box.pack_start(widget, True, True, 0)</pre>
can be replaced with:
<pre>box.add(widget)</pre>

This is as far as you need to go for now. However, in GTK3, GtkVBox and GtkHBox have been deprecated, which means they might be removed in GTK3. The replacement is to use GtkBox directly, and you may wish to make this change now. e.g.:
<pre>vbox = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)</pre>
<pre>hbox = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL, homogeneous=True, spacing=8)</pre>
However, it must be noted that if GtkBox is used directly (instead of using GtkHBox/GtkVBox), the default value of '''expand''' is now '''False'''. The implications of this are:
# You need to check your .add() calls, as previously they would behave as pack_start with expand=True, but now they will behave as expand=False (you need to change them to use pack_start with expand=True to retain the old behaviour)
# Every single pack_start call that has expand=False and padding=0 (and any value of fill) can be converted to .add() for cleanliness

=== GtkAlignment considerations ===

In PyGTK, the gtk.Alignment constructor takes four optional parameters:
# xalign: the fraction of horizontal free space to the left of the child widget. Ranges from 0.0 to 1.0. Default value 0.0.
# yalign: the fraction of vertical free space above the child widget. Ranges from 0.0 to 1.0. Default value 0.0.
# xscale: the fraction of horizontal free space that the child widget absorbs, from 0.0 to 1.0. Default value 0.0.
# yscale: the fraction of vertical free space that the child widget absorbs, from 0.0 to 1.0. Default value 0.0

In PyGI/GTK3, these parameters are still optional when used in the Gtk.Alignment constructor (as keyword arguments, as explained above). However, the default values have changed. They are now:
# xalign: default value 0.5
# yalign: default value 0.5
# xscale: default value 1
# yscale: default value 1

If your code was relying on the default value of 0 for any of these parameters in PyGTK, you will now need to explicitly specify that in your constructor. Similarly, if you were previously using construction parameters to select the now-default values, those parameters can be dropped.

Additionally, PyGTK accepted these construction parameters as positional arguments. As explained above, they must now be converted to keyword arguments.

=== Gtk Menu Popup ===
The Gtk.Menu.popup function now works slightly differently.
The user supplied positioning function now takes different parameters. These are menu, x, y, push_in and user_data.
=== Gdk ===
Previously, gdk was an attribute of the gtk module, which means that it can be called through gtk. For example, if we want to use color_parse():
gtk.gdk.color_parse(color)
However, what we have to do now is:
from gi.repository import Gdk
Then we can modify the code to the following:
Gdk.color_parse(color)

=== Pango ===
Following the release of Gtk3, we should not be importing pango like this:
import pango
In fact, we can now import pango as an attribute within the gtk3 library:
from gi.repository import Pango as pango
=== Gio.Settings from GConf ===
Any use of GConf should be ported to Gio.Settings.

=== Other considerations ===

''self.allocation'' property is no longer available. Please search your code for "self.allocation" and replace it for "self.get_allocation()".

So to get the allocation size:

self.allocation.width
self.allocation.height

should be replaced by:

self.get_allocated_width()
self.get_allocated_height()

=== Constants ===

Most of the constants have slightly different formats, e.g.,

gtk.STATE_NORMAL became Gtk.StateFlags.NORMAL
gtk.RESPONSE_ACCEPT became Gtk.ResponseType.ACCEPT
gtk.JUSTIFY_CENTER became Gtk.Justification.CENTER
gtk.RELIEF_NONE became Gtk.ReliefStyle.NONE

=== Pixbufs ===

The pixbuf libraies are in their own repository

from gi.repository import GdkPixbuf

GdkPixbuf.Pixbuf.new_from_file()

===Changes to the Clipboard===
Two things to note:

1. You need to specify a clipboard using get()
clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)
2. You need to pass a length to set_text()
clipboard.set_text(string, len(string))

See [http://python-gtk-3-tutorial.readthedocs.org/en/latest/clipboard.html] for more details.

===Changes to Drag-and-Drop===
Slightly different syntax:
self.drag_dest_set(Gtk.DestDefaults.ALL, [],
Gdk.DragAction.COPY)
self.drag_dest_set_target_list(Gtk.TargetList.new([]))
self.drag_dest_add_text_targets()
self.connect('drag_data_received', self._drag_data_received)

and:
data.get_text()
or:
data.get_image()

See [http://python-gtk-3-tutorial.readthedocs.org/en/latest/drag_and_drop.html] for more details.

===Going from Drawable to Cairo===

GTK-3 does not support gtk Drawable objects, so the first step is to get your activity running under Cairo.

<pre>
import cairo

# From activity.Activity, you inherit a canvas.
# Create a Cairo context from the window.
cairo_context = self.canvas.get_window().cairo_create()

# Create an XLib surface to be used for drawing
xlib_surface = surface.create_similar(cairo.CONTENT_COLOR,
gtk.gdk.screen_width(),
gtk.gdk.screen_height())

# You'll need a Cairo context from which you'll build a GTK Cairo context
cairo_context = cairo.Context(xlib_surface)
cairo_context = gtk.gdk.CairoContext(cairo_context)

# Use this context as you would a Drawable, substituting Cairo commands
# for gtk commands, e.g.,
cairo_context.move_to(0, 0)
cairo_context.line_to(100, 100)
# Cairo uses floats from 0 to 1 for RGB values
cairo_context.set_source_rgb(r, g, b)
cairo_context.rectangle(x, y, w, h)
cairo_context.fill()

# To invalidate a region to force a refresh, use:
self.canvas.queue_draw_area(x, y, w, h)

# Handle the expose event
# "expose" became "draw" for the cairo signal
def do_expose_event(self, event):
# Create the cairo context
cairo_context = self.canvas.get_window().cairo_create()
cairo_context.rectangle(event.area.x, event.area.y,
event.area.width, event.area.height)
cairo_context.clip()
cairo_context.set_source_surface(xlib_surface)
cairo_context.paint()
</pre>

Pango is a bit different when used with Cairo:

<pre>
import pango, pangocairo

# Again, from the xlib_surface...
cairo_context = cairo.Context(xlib_surface)

# Create a PangoCairo context
cairo_context = pangocairo.CairoContext(cairo_context)

# The pango layout is created from the Cairo context
pango_layout = cairo_context.create_layout()

# You still use pango to set up font descriptions.
fd = pango.FontDescription('Sans')
fd.set_size(12 * pango.SCALE)

# Tell your pango layout about your font description
pango_layout.set_font_description(fd)

# Write text to your pango layout
pango_layout.set_text('Hello world', -1)

# Position it within the Cairo context
cairo_context.save()
cairo_context.translate(x, y)
cairo_context.rotate(pi / 3) # You can rotate text and images in Cairo
cairo_context.set_source_rgb(1, 0, 0)

# Finally, draw the text
cairo_context.update_layout(pango_layout)
cairo_context.show_layout(pango_layout)
cairo_context.restore()
</pre>

To draw a bitmap...

<pre>
# Again, from the xlib_surface...
cairo_context = cairo.Context(xlib_surface)

# Create a gtk context
cairo_context = gtk.gdk.CairoContext(cairo_context)
cairo_context.set_source_pixbuf(pixbuf, x, y)
cairo_context.rectangle(x, y, w, h)
cairo_context.fill()
</pre>

To read a pixel from the xlib surface...

<pre>
# create a new 1x1 cairo surface
cairo_surface = cairo.ImageSurface(cairo.FORMAT_RGB24, 1, 1);
cairo_context = cairo.Context(cairo_surface)
# translate xlib_surface so that target pixel is at 0, 0
cairo_context.set_source_surface(xlib_surface, -x, -y)
cairo_context.rectangle(0,0,1,1)
cairo_context.set_operator(cairo.OPERATOR_SOURCE)
cairo_context.fill()
cairo_surface.flush() # ensure all writing is done
# Read the pixel
return (ord(pixels[2]), ord(pixels[1]), ord(pixels[0]), 0)
</pre>

===Going from Cairo in GTK-2 to Cairo in GTK-3===

(For more detailes, see http://developer.gnome.org/pangomm/2.28/annotated.html)

The Cairo/Pango interaction is a little different:
<pre>
from gi.repository import Pango, PangoCairo

cairo_context = ...
pango_layout = PangoCairo.create_layout(cairo_context)
fd = Pango.FontDescription('Sans')
fd.set_size(12 * Pango.SCALE)
pango_layout.set_font_description(fd)
pango_layout.set_text('Hello World', -1)
cairo_context.set_source_rgb(1, 0, 0)
PangoCairo.update_layout(cairo_context, pango_layout)
PangoCairo.show_layout(cairo_context, pango_layout)
</pre>

The get_extents() method if different in PangoCairo. It calculates an extent as a Rectangle, but doesn't return anything. There is a method, get_logical_extents() that returns a Rectangle. Alas, it is not necessarily available after v1.16. Note that Rectangle is not a list but a class with methods for get_x(), get_y(), get_width(), and get_height(), so you cannot iter over it.

Note that the <samp>cairo.Region</samp> will no longer work in Gtk+3

==== Replacing pixmaps with Cairo ====
You need to replace your pixmaps with Cairo in GTK3. For an example on how this is done, see: http://developer.gnome.org/gtk3/3.5/ch24s02.html#idp129615008

===Taking a screenshot and making a thumbnail===
To make a screenshot of the window:
<pre>
width, height = window.get_width(), window.get_height()
thumb_surface = Gdk.Window.create_similar_surface(window,
cairo.CONTENT_COLOR,
width, height)

thumb_width, thumb_height = style.zoom(100), style.zoom(80)
cairo_context = cairo.Context(thumb_surface)
thumb_scale_w = thumb_width * 1.0 / width
thumb_scale_h = thumb_height * 1.0 / height
cairo_context.scale(thumb_scale_w, thumb_scale_h)
Gdk.cairo_set_source_window(cairo_context, window, 0, 0)
cairo_context.paint()
thumb_surface.write_to_png(png_path_or_filelike_object)
</pre>

===Creating a video widget===

Some necessary changes include:

Using
get_property('window').get_xid()

Instead of
window.xid
Using
set_double_buffered(False)
set_app_paintable(True)
Instead of
unset_flags(gtk.DOUBLE_BUFFERED)
set_flags(gtk.APP_PAINTABLE)

=Hacks to help in porting=

=== Use the same keyboard and mouse ===
If you have an XO, I'm sure you want to take a look at [[User:Humitos/x2x|this]]...
===Use Extended Python debugger===
'''epdb''' library is useful to inspect the code while the Activity is running.
sudo yum install python-epdb
After that I put some trace point in the code where I can stop and make my tests by doing this:
import epdb;epdb.set_trace()
Finally I run Get Books Activity from the Terminal Activity to be able to write some code on a shell. This is the command that I use:
sugar-launch org.laptop.sugar.GetBooksActivity
See also [[Development Team/Debugging]].
===Check logs with ''multitail''===
Here is a really useful command to open new logs automatically: [[User:Humitos/MultiTail]]
===Use the pygobject code as example===
[https://live.gnome.org/PyGObject pygobject] is what we use to make Gtk3 activities. So, it's really useful to take a look at the code examples that are there. Even more, you can run some demo application that show how to use something specific about the library.
*Clone the code:
git clone git://git.gnome.org/pygobject
*Run an example
cd pygobject
cd demos/gtk-demo/demos
python pixbuf.py
*Grep the code to search for something useful
cd pygobject
git grep GdkPixbuf
===Monitoring DBus===
Not sure how this command works, but it can give us an interesting information. If you run this command and plug an USB drive you will see useful information
dbus-monitor --system

=Port to Python 3=
We are migrating towards Python 3. Python 3 does not support GTK+ 2. Hence, once the activity is ported to GTK+ 3, please consider porting the activity from Python 2 to Python 3.

Ref: [https://github.com/sugarlabs/sugar-docs/blob/master/src/python-porting-guide.md Guide to port activities to Python 3]

=Releasing activities (for maintainers)=
Once an activity is ported, a new release can be made. The major version should be greater than the existing one.

Please follow [https://github.com/sugarlabs/sugar-docs/blob/master/src/contributing.md#checklist---maintainer this] guide for releasing a new version

=Notes=
These are the changes implemented by developers while porting activities
*<code>Gtk.Widget.hide_all()</code> does not exist anymore. We should use just <code>.hide</code>
**Ref: http://developer.gnome.org/gtk3/3.5/GtkWidget.html#gtk-widget-hide

*If the code creates some own object, and it defines some properties, you should use '''__gproperties__''' dictionary: http://python-gtk-3-tutorial.readthedocs.org/en/latest/objects.html#GObject.GObject.__gproperties__
*<code>Gtk.ListStore</code> doesn't have the method '''.reorder'''. There is a [https://bugzilla.gnome.org/show_bug.cgi?id=677941 ticket] reported upstream about this.
*I replaced the use of <code>dbus</code> by [http://developer.gnome.org/gio/unstable/pt02.html Gio] to monitor the (dis)connection of pen drives
*Migrate custom signals:
**If you have defined custom gtk objects with custom signal you should migrate them to [http://python-gtk-3-tutorial.readthedocs.org/en/latest/objects.html the new way] to do this. You should replace this: from gobject import signal_new, TYPE_INT, TYPE_STRING, TYPE_BOOLEAN, \ TYPE_PYOBJECT, TYPE_NONE, SIGNAL_RUN_LAST signal_new('extlistview-modified', gtk.TreeView, SIGNAL_RUN_LAST, TYPE_NONE, ()) by adding the signal definition inside the object that you are creating using the <code>__gsignals__</code> dictionary like this (in this case Gtk.TreeView is the class that our object inherits): from gi.repository import GObject class ExtListView(Gtk.TreeView): __gsignals__ = { 'extlistview-modified': (GObject.SignalFlags.RUN_LAST, None, ()), } The last argument of the signal definition are the argument types that the callback will receive.
* Change the mouse cursor
** Example use case: When the activity is working and we want to show a ''work in progress'' cursor.
** Replace this:
self.window.set_cursor(gtk.gdk.Cursor(gtk.gdk.WATCH))
with:
from gi.repository import Gdk
self.get_window().set_cursor(Gdk.Cursor(Gdk.CursorType.WATCH))
=Resources=
*PyGI Documentation: https://lazka.github.io/pgi-docs/
*PyGtk documentation
**Gtk3: [http://python-gtk-3-tutorial.readthedocs.org/ http://python-gtk-3-tutorial.readthedocs.org]
**gtk2: http://www.pygtk.org/docs/pygtk/
*Reference Manual
**Gtk3: http://developer.gnome.org/gtk3/3.4/
*Gdk documentation:
**Gdk3: http://developer.gnome.org/gdk/2.24/
*OLPC Documentation: http://wiki.laptop.org/go/Activities/PortingToGtk3
*Used to know the arguments of <code>GdkPixbuf.Pixbuf.save_to_bufferv</code> https://mail.gnome.org/archives/javascript-list/2011-March/msg00001.html

* Pango documentation: http://developer.gnome.org/pangomm

* Gst-1.0 documentation: http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/index.html

* Gst-1.0 porting hints: https://wiki.ubuntu.com/Novacut/GStreamer1.0
[[Category:Developer]]

= More porting wiki pages =

{{Special:PrefixIndex/Features/GTK3/Porting}}

Features/GTK3/Porting

2018-04-04T15:42:39Z

Pro-panda: Merge useful content from https://wiki.sugarlabs.org/go/Features/GTK3/Porting/GetBooks

=Porting an existing activity to GTK3=
This is a guide to porting an existing activity from GTK2 to [http://developer.gnome.org/gtk3/stable/ GTK3]. It also shows the changes to use the new Sugar toolkit that also now uses [[Features/GTK3|GTK3]]. This guide uses the [https://github.com/sugarlabs/hello-world hello-world] activity as a simple example.

Here are some instances of porting activities, for reference:
* [https://github.com/sugarlabs/biorhythm/commit/c16de3b70cce2cc6f8af933e2b062c844a47c144/ Biorhythm]
* [https://github.com/sugarlabs/peru-learns-english-activity/commit/caa2cde526b3823a5a1f7d200a76ad5bc3502b0e Peru Learns English, includes GStreamer and GST update]
* [https://github.com/sugarlabs/jump/commit/b75410d2879d9829df942726f5465b7cf5a9d98d Port of Jump Activity]
* [https://github.com/sugarlabs/iknowMadagascar/commit/44ba42645ac4fcd9e06b4add7fa3b6ce2e0d9c3d Port of I-know-Madagascar]

=Steps to Port an Activity to Gtk3=
#Read the [http://wiki.sugarlabs.org/go/Features/GTK3 Sugar Official Wiki]
#Resolve any existing pull requests before porting to avoid conflicts at a later stage.
#Run this [http://git.gnome.org/browse/pygobject/tree/pygi-convert.sh script] that will convert automatically things as much as it can. This is to avoid some stressful manually conversions that a "simple script" can do using ''sed'' :)
#Convert all the <code>from sugar.* import</code> to <code>from sugar</code>'''3'''<code>.* import</code> using [http://dev.laptop.org/~manuq/sugar-convert.sh this script]
#Follow the [[Development Team/Code guidelines|Code Guidelines]] during all the porting process
#Make the API changes in sugar-toolkit-gtk3
#Write comments on the code, by adding '''# README:''', '''# TODO:''' and '''# FIXME:''' explaining what are the problems that you are having with that chunk of code. Put a link if it's necessary
Note: If you are considering to fix some ''pep8'' or ''pylint'' errors/warnings, please create two separate patch files (one for the port and one for the pylint/pep8 changes). If we follow this way it is easier to check the port patches, if not the information about the port itself it's difficult to follow

==Cleanup, adopt to API changes in sugar-toolkit-gtk3 ==
* the keep button has been removed completely
* the old-style toolbar has been removed
* set_toolbar_box is used instead of set_toolbox (see in [http://git.sugarlabs.org/~walter/abacus/walter-cairo/commit/6871dd340a89ade3b5361457e1bd1d58276a8efc Abacus])
* remove import of deprecated ActivityToolbox (see [http://git.sugarlabs.org/hello-world/mainline/commit/22060a3063b2d6fd38d6b1cd8d44946170255af3 hello-world])
* support for 'service_name' and 'class' has been removed from the activity.info make sure you are using: 'bundle_id' instead of 'service_name' and 'exec' instead of 'class' (see in [http://git.sugarlabs.org/record/mainline/commit/6e8968c71e474e2d8d86886badf5cf7d70217dc5 Record])
* <code>sugar3.activity.Activity</code> doesn't have the ''window'' attribute. Use the <code>.get_window()</code> method instead.

==Port the activity from GTK2 to GTK3==
To start, change the importing instruction for GTK from
import gtk
to
import gi
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk

Note that require_version needs to called only the first time when Gtk is being imported.

Here are some more examples of imports that may be used:
<pre>
from gi.repository import Gdk, Pango, Gobject
</pre>

Then you have to change each call that involves Gtk, for example creating a button will look now like this:
button = Gtk.Button()

A simple hello world program in GTK3 looks like this:
<pre>
from gi.repository import Gtk

def _destroy_cb(widget, data=None):
Gtk.main_quit()

w = Gtk.Window()
w.connect("destroy", _destroy_cb)
label = Gtk.Label('Hello World!')
w.add(label)
w.show_all()

Gtk.main()
</pre>

For porting your activity you do have to change your calls for accessing widgets and services in the new GTK3 sugar-toolkit as well. The new namespace is called [https://developer.sugarlabs.org/sugar3/ sugar3], trying to reflect that GTK3 is the underlying technology. For example the import of the base activity class has to be changed from
from sugar.activity import activity
to
from sugar3.activity import activity

Make sure you change the setup.py in your activity to point to the new toolkit as well:
from sugar3.activity import bundlebuilder

The changes that were needed to port the hello-world activity can be seen in [http://git.sugarlabs.org/hello-world/mainline/commit/508e1c518b56cbde5508e560c8a2ff38a3518583 this commit].

Ok, let's do these changes now for your activity. Make sure you are in your master branch using the 'git branch' command (the master branch should have a '*' before it). Make your changes, commit them ('git commit -a') and push them to the remote repository ('git push origin master').

====Simple example on creating a toolbar====
One of Sugar's activity most unique user interface includes the toolbar. In order to reference the relevant modules and graphics, the sugar3 library has to be imported. These are the relevant ones that would enable us to create a simple toolbar containing the activity button and the stop button.
<pre>
from sugar3.activity import activity
from sugar3.graphics.toolbarbox import ToolbarBox
from sugar3.activity.widgets import ActivityToolbarButton
from sugar3.activity.widgets import StopButton
from sugar3.graphics.toolbarbox import ToolbarButton
from sugar3.graphics import style
</pre>

Since the ActivityToolbar() module has been deprecated, the toolbar can now be called using
ToolbarBox()
Then, from the ToolbarBox(), include the ActivityButton and StopButton. In order for the StopButton to be align to the right as per Sugar activity interface, a separator has to be included as well.

<pre>
toolbar_box = ToolbarBox()

activity_button = ActivityToolbarButton(self)
toolbar_box.toolbar.insert(activity_button, 0)
activity_button.show()

separator = Gtk.SeparatorToolItem()
separator.props.draw = False
separator.set_expand(True)
toolbar_box.toolbar.insert(separator, -1)
separator.show()

stop_button = StopButton(self)
toolbar_box.toolbar.insert(stop_button, -1)
stop_button.show()
self.set_toolbar_box(toolbar_box)
toolbar_box.show()
</pre>

===Tools===
There are tools to help you do the porting. There is a script in the pygobject repository for porting called [http://git.gnome.org/browse/pygobject/tree/pygi-convert.sh pygi-convert.sh], more info about the script can be found in [http://live.gnome.org/PyGObject/IntrospectionPorting the PyGObject Introspection Porting guide].

Here is a script to automate the rename of the imports '''sugar''' to '''sugar3''': [http://dev.laptop.org/~manuq/sugar-convert.sh sugar-convert.sh].

If you are having trouble finding how a particular GTK class/method/constant has been named in PyGI, run [http://dev.laptop.org/~dsd/20110806/pygi-enumerate.py pygi-enumerate.py] and grep the output. (this app lists all identified methods and constants). Usage example:

<pre>
$ python pygi-enumerate.py | grep get_selection
Gtk.AccelLabel.get_selection_bounds() (instance method)
Gtk.Editable.get_selection_bounds() (instance method)
Gtk.Entry.get_selection_bounds() (instance method)
Gtk.IconView.get_selection_mode() (instance method)
Gtk.Label.get_selection_bounds() (instance method)
Gtk.SelectionData.get_selection() (instance method)
Gtk.SpinButton.get_selection_bounds() (instance method)
Gtk.TextBuffer.get_selection_bound() (instance method)
Gtk.TextBuffer.get_selection_bounds() (instance method)
Gtk.TreeView.get_selection() (instance method)
</pre>

=== Constructor considerations ===

With PyGI it is possible to use Python-like constructors, or "new" functions e.g. the following are (usually) equivalent:
label = Gtk.Button()
label = Gtk.Button.new()

However, the first form is preferred: it is more Python-like. Internally, the difference is that Gtk.Label.new() translates to a call to gtk_label_new(), whereas Gtk.Label() (the preferred form) will directly construct an instance of GtkLabel at the GObject level.

If the constructor takes parameters, they '''must''' be named. The parameters correspond to GObject properties in the API documentation which are usually marked as "Construct". For example, the following code will not work:

expander = Gtk.Expander("my expander")

The (confusing) error is:
TypeError: GObject.__init__() takes exactly 0 arguments (1 given)

The solution is to go to the [http://developer.gnome.org/gtk3/3.2/GtkExpander.html#GtkExpander.properties GtkExpander API documentation] and find the appropriate property that we wish to set. In this case it is label (which is a Construct property, further increasing our confidence of success), so the code should be:

expander = Gtk.Expander(label="my expander")

Combining the two points above, if you wish to call a construct-like function such as gtk_button_new_with_label(), you do have the option of calling Gtk.Button.new_with_label(), however if we check the [http://developer.gnome.org/gtk3/3.2/GtkButton.html#GtkButton.properties GtkButton properties] we see one called "label" which is equivalent. Therefore gtk_button_new_with_label("foo") should be called as:
button = Gtk.Button(label="foo")

=== HBox, VBox, pack_start and pack_end ===

GtkHBox and GtkVBox, commonly used containers in GTK2 code, have pack_start and pack_end methods. These take 4 parameters:
# The widget to pack into the container
# '''expand''': Whether the child should receive extra space when the container grows (default True)
# '''fill''': True if space given to child by the expand option is actually allocated to child, rather than just padding it. This parameter has no effect if expand is set to False. A child is always allocated the full height of a gtk.HBox and the full width of a gtk.VBox. This option affects the other dimension. (default True)
# '''padding''': extra space in pixels to put between child and its neighbor (default 0)

In PyGTK, the expand, fill and padding parameters were optional: if unspecified, the default values above were used. In PyGI, these parameters are '''not''' optional: all 4 must be specified. Hence the rules for adding in the extra parameters are:

# If '''expand''' was not set, use value True
# If '''fill''' was not set, use value True. (however, if expand is False, this parameter gets ignored so False is an equally acceptable option when expand=False)
# If '''padding''' was not set, use value 0.

These parameters can be specified either as positional arguments or as named keyword arguments, however all 4 must always be specified. Some developers prefer keyword arguments, arguing that the following:
<pre>box.pack_start(widget, expand=True, fill=False, padding=4)</pre>
is much more readable than:
<pre>box.pack_start(widget, True, False, 4)</pre>

However, these functions are called extremely often; any mildly seasoned GTK developer will have memorized the order and meaning of the parameters. Some developers therefore prefer to avoid the extra work of dropping in hundreds of keyword arguments throughout the code and just use the positional ones. This is really up to you.

If you are using pack_start with the default values (expand=True, fill=True and padding=0), you can avoid using pack_start (and the parameter pain that it brings with it) by just using .add for some added cleanliness, e.g.
<pre>box.pack_start(widget, True, True, 0)</pre>
can be replaced with:
<pre>box.add(widget)</pre>

This is as far as you need to go for now. However, in GTK3, GtkVBox and GtkHBox have been deprecated, which means they might be removed in GTK3. The replacement is to use GtkBox directly, and you may wish to make this change now. e.g.:
<pre>vbox = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)</pre>
<pre>hbox = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL, homogeneous=True, spacing=8)</pre>
However, it must be noted that if GtkBox is used directly (instead of using GtkHBox/GtkVBox), the default value of '''expand''' is now '''False'''. The implications of this are:
# You need to check your .add() calls, as previously they would behave as pack_start with expand=True, but now they will behave as expand=False (you need to change them to use pack_start with expand=True to retain the old behaviour)
# Every single pack_start call that has expand=False and padding=0 (and any value of fill) can be converted to .add() for cleanliness

=== GtkAlignment considerations ===

In PyGTK, the gtk.Alignment constructor takes four optional parameters:
# xalign: the fraction of horizontal free space to the left of the child widget. Ranges from 0.0 to 1.0. Default value 0.0.
# yalign: the fraction of vertical free space above the child widget. Ranges from 0.0 to 1.0. Default value 0.0.
# xscale: the fraction of horizontal free space that the child widget absorbs, from 0.0 to 1.0. Default value 0.0.
# yscale: the fraction of vertical free space that the child widget absorbs, from 0.0 to 1.0. Default value 0.0

In PyGI/GTK3, these parameters are still optional when used in the Gtk.Alignment constructor (as keyword arguments, as explained above). However, the default values have changed. They are now:
# xalign: default value 0.5
# yalign: default value 0.5
# xscale: default value 1
# yscale: default value 1

If your code was relying on the default value of 0 for any of these parameters in PyGTK, you will now need to explicitly specify that in your constructor. Similarly, if you were previously using construction parameters to select the now-default values, those parameters can be dropped.

Additionally, PyGTK accepted these construction parameters as positional arguments. As explained above, they must now be converted to keyword arguments.

=== Gtk Menu Popup ===
The Gtk.Menu.popup function now works slightly differently.
The user supplied positioning function now takes different parameters. These are menu, x, y, push_in and user_data.
=== Gdk ===
Previously, gdk was an attribute of the gtk module, which means that it can be called through gtk. For example, if we want to use color_parse():
gtk.gdk.color_parse(color)
However, what we have to do now is:
from gi.repository import Gdk
Then we can modify the code to the following:
Gdk.color_parse(color)

=== Pango ===
Following the release of Gtk3, we should not be importing pango like this:
import pango
In fact, we can now import pango as an attribute within the gtk3 library:
from gi.repository import Pango as pango
=== Gio.Settings from GConf ===
Any use of GConf should be ported to Gio.Settings.

=== Other considerations ===

''self.allocation'' property is no longer available. Please search your code for "self.allocation" and replace it for "self.get_allocation()".

So to get the allocation size:

self.allocation.width
self.allocation.height

should be replaced by:

self.get_allocated_width()
self.get_allocated_height()

=== Constants ===

Most of the constants have slightly different formats, e.g.,

gtk.STATE_NORMAL became Gtk.StateFlags.NORMAL
gtk.RESPONSE_ACCEPT became Gtk.ResponseType.ACCEPT
gtk.JUSTIFY_CENTER became Gtk.Justification.CENTER
gtk.RELIEF_NONE became Gtk.ReliefStyle.NONE

=== Pixbufs ===

The pixbuf libraies are in their own repository

from gi.repository import GdkPixbuf

GdkPixbuf.Pixbuf.new_from_file()

===Changes to the Clipboard===
Two things to note:

1. You need to specify a clipboard using get()
clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)
2. You need to pass a length to set_text()
clipboard.set_text(string, len(string))

See [http://python-gtk-3-tutorial.readthedocs.org/en/latest/clipboard.html] for more details.

===Changes to Drag-and-Drop===
Slightly different syntax:
self.drag_dest_set(Gtk.DestDefaults.ALL, [],
Gdk.DragAction.COPY)
self.drag_dest_set_target_list(Gtk.TargetList.new([]))
self.drag_dest_add_text_targets()
self.connect('drag_data_received', self._drag_data_received)

and:
data.get_text()
or:
data.get_image()

See [http://python-gtk-3-tutorial.readthedocs.org/en/latest/drag_and_drop.html] for more details.

===Going from Drawable to Cairo===

GTK-3 does not support gtk Drawable objects, so the first step is to get your activity running under Cairo.

<pre>
import cairo

# From activity.Activity, you inherit a canvas.
# Create a Cairo context from the window.
cairo_context = self.canvas.get_window().cairo_create()

# Create an XLib surface to be used for drawing
xlib_surface = surface.create_similar(cairo.CONTENT_COLOR,
gtk.gdk.screen_width(),
gtk.gdk.screen_height())

# You'll need a Cairo context from which you'll build a GTK Cairo context
cairo_context = cairo.Context(xlib_surface)
cairo_context = gtk.gdk.CairoContext(cairo_context)

# Use this context as you would a Drawable, substituting Cairo commands
# for gtk commands, e.g.,
cairo_context.move_to(0, 0)
cairo_context.line_to(100, 100)
# Cairo uses floats from 0 to 1 for RGB values
cairo_context.set_source_rgb(r, g, b)
cairo_context.rectangle(x, y, w, h)
cairo_context.fill()

# To invalidate a region to force a refresh, use:
self.canvas.queue_draw_area(x, y, w, h)

# Handle the expose event
# "expose" became "draw" for the cairo signal
def do_expose_event(self, event):
# Create the cairo context
cairo_context = self.canvas.get_window().cairo_create()
cairo_context.rectangle(event.area.x, event.area.y,
event.area.width, event.area.height)
cairo_context.clip()
cairo_context.set_source_surface(xlib_surface)
cairo_context.paint()
</pre>

Pango is a bit different when used with Cairo:

<pre>
import pango, pangocairo

# Again, from the xlib_surface...
cairo_context = cairo.Context(xlib_surface)

# Create a PangoCairo context
cairo_context = pangocairo.CairoContext(cairo_context)

# The pango layout is created from the Cairo context
pango_layout = cairo_context.create_layout()

# You still use pango to set up font descriptions.
fd = pango.FontDescription('Sans')
fd.set_size(12 * pango.SCALE)

# Tell your pango layout about your font description
pango_layout.set_font_description(fd)

# Write text to your pango layout
pango_layout.set_text('Hello world', -1)

# Position it within the Cairo context
cairo_context.save()
cairo_context.translate(x, y)
cairo_context.rotate(pi / 3) # You can rotate text and images in Cairo
cairo_context.set_source_rgb(1, 0, 0)

# Finally, draw the text
cairo_context.update_layout(pango_layout)
cairo_context.show_layout(pango_layout)
cairo_context.restore()
</pre>

To draw a bitmap...

<pre>
# Again, from the xlib_surface...
cairo_context = cairo.Context(xlib_surface)

# Create a gtk context
cairo_context = gtk.gdk.CairoContext(cairo_context)
cairo_context.set_source_pixbuf(pixbuf, x, y)
cairo_context.rectangle(x, y, w, h)
cairo_context.fill()
</pre>

To read a pixel from the xlib surface...

<pre>
# create a new 1x1 cairo surface
cairo_surface = cairo.ImageSurface(cairo.FORMAT_RGB24, 1, 1);
cairo_context = cairo.Context(cairo_surface)
# translate xlib_surface so that target pixel is at 0, 0
cairo_context.set_source_surface(xlib_surface, -x, -y)
cairo_context.rectangle(0,0,1,1)
cairo_context.set_operator(cairo.OPERATOR_SOURCE)
cairo_context.fill()
cairo_surface.flush() # ensure all writing is done
# Read the pixel
return (ord(pixels[2]), ord(pixels[1]), ord(pixels[0]), 0)
</pre>

===Going from Cairo in GTK-2 to Cairo in GTK-3===

(For more detailes, see http://developer.gnome.org/pangomm/2.28/annotated.html)

The Cairo/Pango interaction is a little different:
<pre>
from gi.repository import Pango, PangoCairo

cairo_context = ...
pango_layout = PangoCairo.create_layout(cairo_context)
fd = Pango.FontDescription('Sans')
fd.set_size(12 * Pango.SCALE)
pango_layout.set_font_description(fd)
pango_layout.set_text('Hello World', -1)
cairo_context.set_source_rgb(1, 0, 0)
PangoCairo.update_layout(cairo_context, pango_layout)
PangoCairo.show_layout(cairo_context, pango_layout)
</pre>

The get_extents() method if different in PangoCairo. It calculates an extent as a Rectangle, but doesn't return anything. There is a method, get_logical_extents() that returns a Rectangle. Alas, it is not necessarily available after v1.16. Note that Rectangle is not a list but a class with methods for get_x(), get_y(), get_width(), and get_height(), so you cannot iter over it.

Note that the <samp>cairo.Region</samp> will no longer work in Gtk+3

==== Replacing pixmaps with Cairo ====
You need to replace your pixmaps with Cairo in GTK3. For an example on how this is done, see: http://developer.gnome.org/gtk3/3.5/ch24s02.html#idp129615008

===Taking a screenshot and making a thumbnail===
To make a screenshot of the window:
<pre>
width, height = window.get_width(), window.get_height()
thumb_surface = Gdk.Window.create_similar_surface(window,
cairo.CONTENT_COLOR,
width, height)

thumb_width, thumb_height = style.zoom(100), style.zoom(80)
cairo_context = cairo.Context(thumb_surface)
thumb_scale_w = thumb_width * 1.0 / width
thumb_scale_h = thumb_height * 1.0 / height
cairo_context.scale(thumb_scale_w, thumb_scale_h)
Gdk.cairo_set_source_window(cairo_context, window, 0, 0)
cairo_context.paint()
thumb_surface.write_to_png(png_path_or_filelike_object)
</pre>

===Creating a video widget===

Some necessary changes include:

Using
get_property('window').get_xid()

Instead of
window.xid
Using
set_double_buffered(False)
set_app_paintable(True)
Instead of
unset_flags(gtk.DOUBLE_BUFFERED)
set_flags(gtk.APP_PAINTABLE)

=Hacks to help in porting=

=== Use the same keyboard and mouse ===
If you have an XO, I'm sure you want to take a look at [[User:Humitos/x2x|this]]...
===Use Extended Python debugger===
'''epdb''' library is useful to inspect the code while the Activity is running.
sudo yum install python-epdb
After that I put some trace point in the code where I can stop and make my tests by doing this:
import epdb;epdb.set_trace()
Finally I run Get Books Activity from the Terminal Activity to be able to write some code on a shell. This is the command that I use:
sugar-launch org.laptop.sugar.GetBooksActivity
See also [[Development Team/Debugging]].
===Check logs with ''multitail''===
Here is a really useful command to open new logs automatically: [[User:Humitos/MultiTail]]
===Use the pygobject code as example===
[https://live.gnome.org/PyGObject pygobject] is what we use to make Gtk3 activities. So, it's really useful to take a look at the code examples that are there. Even more, you can run some demo application that show how to use something specific about the library.
*Clone the code:
git clone git://git.gnome.org/pygobject
*Run an example
cd pygobject
cd demos/gtk-demo/demos
python pixbuf.py
*Grep the code to search for something useful
cd pygobject
git grep GdkPixbuf
===Monitoring DBus===
Not sure how this command works, but it can give us an interesting information. If you run this command and plug an USB drive you will see useful information
dbus-monitor --system

=Port to Python 3=
We are migrating towards Python 3. Python 3 does not support GTK+ 2. Hence, once the activity is ported to GTK+ 3, please consider porting the activity from Python 2 to Python 3.

Ref: [https://github.com/sugarlabs/sugar-docs/blob/master/src/python-porting-guide.md Guide to port activities to Python 3]

=Releasing activities (for maintainers)=
Once an activity is ported, a new release can be made. The major version should be greater than the existing one.

Please follow [https://github.com/sugarlabs/sugar-docs/blob/master/src/contributing.md#checklist---maintainer this] guide for releasing a new version

=Notes=
These are the changes implemented by developers while porting activities
*<code>Gtk.Widget.hide_all()</code> does not exist anymore. We should use just <code>.hide</code>
**Ref: http://developer.gnome.org/gtk3/3.5/GtkWidget.html#gtk-widget-hide

*If the code creates some own object, and it defines some properties, you should use '''__gproperties__''' dictionary: http://python-gtk-3-tutorial.readthedocs.org/en/latest/objects.html#GObject.GObject.__gproperties__
*<code>Gtk.ListStore</code> doesn't have the method '''.reorder'''. There is a [https://bugzilla.gnome.org/show_bug.cgi?id=677941 ticket] reported upstream about this.
*I replaced the use of <code>dbus</code> by [http://developer.gnome.org/gio/unstable/pt02.html Gio] to monitor the (dis)connection of pen drives
*Migrate custom signals:
**If you have defined custom gtk objects with custom signal you should migrate them to [http://python-gtk-3-tutorial.readthedocs.org/en/latest/objects.html the new way] to do this. You should replace this: from gobject import signal_new, TYPE_INT, TYPE_STRING, TYPE_BOOLEAN, \ TYPE_PYOBJECT, TYPE_NONE, SIGNAL_RUN_LAST signal_new('extlistview-modified', gtk.TreeView, SIGNAL_RUN_LAST, TYPE_NONE, ()) by adding the signal definition inside the object that you are creating using the <code>__gsignals__</code> dictionary like this (in this case Gtk.TreeView is the class that our object inherits): from gi.repository import GObject class ExtListView(Gtk.TreeView): __gsignals__ = { 'extlistview-modified': (GObject.SignalFlags.RUN_LAST, None, ()), } The last argument of the signal definition are the argument types that the callback will receive.
* Change the mouse cursor
** Example use case: When the activity is working and we want to show a ''work in progress'' cursor.
** Replace this:
self.window.set_cursor(gtk.gdk.Cursor(gtk.gdk.WATCH))
with:
from gi.repository import Gdk
self.get_window().set_cursor(Gdk.Cursor(Gdk.CursorType.WATCH))
=Resources=
*PyGI Documentation: https://lazka.github.io/pgi-docs/
*PyGtk documentation
**Gtk3: [http://python-gtk-3-tutorial.readthedocs.org/ http://python-gtk-3-tutorial.readthedocs.org]
**gtk2: http://www.pygtk.org/docs/pygtk/
*Reference Manual
**Gtk3: http://developer.gnome.org/gtk3/3.4/
*Gdk documentation:
**Gdk3: http://developer.gnome.org/gdk/2.24/
*OLPC Documentation: http://wiki.laptop.org/go/Activities/PortingToGtk3
*Used to know the arguments of <code>GdkPixbuf.Pixbuf.save_to_bufferv</code> https://mail.gnome.org/archives/javascript-list/2011-March/msg00001.html

* Pango documentation: http://developer.gnome.org/pangomm

* Gst-1.0 documentation: http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/index.html

* Gst-1.0 porting hints: https://wiki.ubuntu.com/Novacut/GStreamer1.0
[[Category:Developer]]

= More porting wiki pages =

{{Special:PrefixIndex/Features/GTK3/Porting}}

Features/GTK3/Porting

2018-04-04T14:43:23Z

Pro-panda:

=Porting an existing activity to GTK3=
This is a guide to porting an existing activity from GTK2 to [http://developer.gnome.org/gtk3/stable/ GTK3]. It also shows the changes to use the new Sugar toolkit that also now uses [[Features/GTK3|GTK3]]. This guide uses the [https://github.com/sugarlabs/hello-world hello-world] activity as a simple example.

There is another guide that uses this one as reference. It was made while porting GetBooks Activity [[Features/GTK3/Porting/GetBooks]]

If you would like to reference other examples of GTK3 port:
* [https://github.com/sugarlabs/biorhythm/commit/c16de3b70cce2cc6f8af933e2b062c844a47c144/ Biorhythm]
* [https://github.com/sugarlabs/peru-learns-english-activity/commit/caa2cde526b3823a5a1f7d200a76ad5bc3502b0e Peru Learns English, includes GStreamer and GST update]

==Cleanup, adopt to API changes in sugar-toolkit-gtk3 ==
* the keep button has been removed completely
* the old-style toolbar has been removed
* set_toolbar_box is used instead of set_toolbox (see in [http://git.sugarlabs.org/~walter/abacus/walter-cairo/commit/6871dd340a89ade3b5361457e1bd1d58276a8efc Abacus])
* remove import of deprecated ActivityToolbox (see [http://git.sugarlabs.org/hello-world/mainline/commit/22060a3063b2d6fd38d6b1cd8d44946170255af3 hello-world])
* support for 'service_name' and 'class' has been removed from the activity.info make sure you are using: 'bundle_id' instead of 'service_name' and 'exec' instead of 'class' (see in [http://git.sugarlabs.org/record/mainline/commit/6e8968c71e474e2d8d86886badf5cf7d70217dc5 Record])

==Port the activity from GTK2 to GTK3==
To start, change the importing instruction for GTK from
import gtk
to
import gi
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk

Note that require_version needs to called only the first time when Gtk is being imported.

Here are some more examples of imports that may be used:
<pre>
from gi.repository import Gdk, Pango, Gobject
</pre>

Then you have to change each call that involves Gtk, for example creating a button will look now like this:
button = Gtk.Button()

A simple hello world program in GTK3 looks like this:
<pre>
from gi.repository import Gtk

def _destroy_cb(widget, data=None):
Gtk.main_quit()

w = Gtk.Window()
w.connect("destroy", _destroy_cb)
label = Gtk.Label('Hello World!')
w.add(label)
w.show_all()

Gtk.main()
</pre>

For porting your activity you do have to change your calls for accessing widgets and services in the new GTK3 sugar-toolkit as well. The new namespace is called [https://developer.sugarlabs.org/sugar3/ sugar3], trying to reflect that GTK3 is the underlying technology. For example the import of the base activity class has to be changed from
from sugar.activity import activity
to
from sugar3.activity import activity

Make sure you change the setup.py in your activity to point to the new toolkit as well:
from sugar3.activity import bundlebuilder

The changes that were needed to port the hello-world activity can be seen in [http://git.sugarlabs.org/hello-world/mainline/commit/508e1c518b56cbde5508e560c8a2ff38a3518583 this commit].

Ok, let's do these changes now for your activity. Make sure you are in your master branch using the 'git branch' command (the master branch should have a '*' before it). Make your changes, commit them ('git commit -a') and push them to the remote repository ('git push origin master').

====Simple example on creating a toolbar====
One of Sugar's activity most unique user interface includes the toolbar. In order to reference the relevant modules and graphics, the sugar3 library has to be imported. These are the relevant ones that would enable us to create a simple toolbar containing the activity button and the stop button.
<pre>
from sugar3.activity import activity
from sugar3.graphics.toolbarbox import ToolbarBox
from sugar3.activity.widgets import ActivityToolbarButton
from sugar3.activity.widgets import StopButton
from sugar3.graphics.toolbarbox import ToolbarButton
from sugar3.graphics import style
</pre>

Since the ActivityToolbar() module has been deprecated, the toolbar can now be called using
ToolbarBox()
Then, from the ToolbarBox(), include the ActivityButton and StopButton. In order for the StopButton to be align to the right as per Sugar activity interface, a separator has to be included as well.

<pre>
toolbar_box = ToolbarBox()

activity_button = ActivityToolbarButton(self)
toolbar_box.toolbar.insert(activity_button, 0)
activity_button.show()

separator = Gtk.SeparatorToolItem()
separator.props.draw = False
separator.set_expand(True)
toolbar_box.toolbar.insert(separator, -1)
separator.show()

stop_button = StopButton(self)
toolbar_box.toolbar.insert(stop_button, -1)
stop_button.show()
self.set_toolbar_box(toolbar_box)
toolbar_box.show()
</pre>

===Tools===
There are tools to help you do the porting. There is a script in the pygobject repository for porting called [http://git.gnome.org/browse/pygobject/tree/pygi-convert.sh pygi-convert.sh], more info about the script can be found in [http://live.gnome.org/PyGObject/IntrospectionPorting the PyGObject Introspection Porting guide].

Here is a script to automate the rename of the imports '''sugar''' to '''sugar3''': [http://dev.laptop.org/~manuq/sugar-convert.sh sugar-convert.sh].

If you are having trouble finding how a particular GTK class/method/constant has been named in PyGI, run [http://dev.laptop.org/~dsd/20110806/pygi-enumerate.py pygi-enumerate.py] and grep the output. (this app lists all identified methods and constants). Usage example:

<pre>
$ python pygi-enumerate.py | grep get_selection
Gtk.AccelLabel.get_selection_bounds() (instance method)
Gtk.Editable.get_selection_bounds() (instance method)
Gtk.Entry.get_selection_bounds() (instance method)
Gtk.IconView.get_selection_mode() (instance method)
Gtk.Label.get_selection_bounds() (instance method)
Gtk.SelectionData.get_selection() (instance method)
Gtk.SpinButton.get_selection_bounds() (instance method)
Gtk.TextBuffer.get_selection_bound() (instance method)
Gtk.TextBuffer.get_selection_bounds() (instance method)
Gtk.TreeView.get_selection() (instance method)
</pre>

=== Constructor considerations ===

With PyGI it is possible to use Python-like constructors, or "new" functions e.g. the following are (usually) equivalent:
label = Gtk.Button()
label = Gtk.Button.new()

However, the first form is preferred: it is more Python-like. Internally, the difference is that Gtk.Label.new() translates to a call to gtk_label_new(), whereas Gtk.Label() (the preferred form) will directly construct an instance of GtkLabel at the GObject level.

If the constructor takes parameters, they '''must''' be named. The parameters correspond to GObject properties in the API documentation which are usually marked as "Construct". For example, the following code will not work:

expander = Gtk.Expander("my expander")

The (confusing) error is:
TypeError: GObject.__init__() takes exactly 0 arguments (1 given)

The solution is to go to the [http://developer.gnome.org/gtk3/3.2/GtkExpander.html#GtkExpander.properties GtkExpander API documentation] and find the appropriate property that we wish to set. In this case it is label (which is a Construct property, further increasing our confidence of success), so the code should be:

expander = Gtk.Expander(label="my expander")

Combining the two points above, if you wish to call a construct-like function such as gtk_button_new_with_label(), you do have the option of calling Gtk.Button.new_with_label(), however if we check the [http://developer.gnome.org/gtk3/3.2/GtkButton.html#GtkButton.properties GtkButton properties] we see one called "label" which is equivalent. Therefore gtk_button_new_with_label("foo") should be called as:
button = Gtk.Button(label="foo")

=== HBox, VBox, pack_start and pack_end ===

GtkHBox and GtkVBox, commonly used containers in GTK2 code, have pack_start and pack_end methods. These take 4 parameters:
# The widget to pack into the container
# '''expand''': Whether the child should receive extra space when the container grows (default True)
# '''fill''': True if space given to child by the expand option is actually allocated to child, rather than just padding it. This parameter has no effect if expand is set to False. A child is always allocated the full height of a gtk.HBox and the full width of a gtk.VBox. This option affects the other dimension. (default True)
# '''padding''': extra space in pixels to put between child and its neighbor (default 0)

In PyGTK, the expand, fill and padding parameters were optional: if unspecified, the default values above were used. In PyGI, these parameters are '''not''' optional: all 4 must be specified. Hence the rules for adding in the extra parameters are:

# If '''expand''' was not set, use value True
# If '''fill''' was not set, use value True. (however, if expand is False, this parameter gets ignored so False is an equally acceptable option when expand=False)
# If '''padding''' was not set, use value 0.

These parameters can be specified either as positional arguments or as named keyword arguments, however all 4 must always be specified. Some developers prefer keyword arguments, arguing that the following:
<pre>box.pack_start(widget, expand=True, fill=False, padding=4)</pre>
is much more readable than:
<pre>box.pack_start(widget, True, False, 4)</pre>

However, these functions are called extremely often; any mildly seasoned GTK developer will have memorized the order and meaning of the parameters. Some developers therefore prefer to avoid the extra work of dropping in hundreds of keyword arguments throughout the code and just use the positional ones. This is really up to you.

If you are using pack_start with the default values (expand=True, fill=True and padding=0), you can avoid using pack_start (and the parameter pain that it brings with it) by just using .add for some added cleanliness, e.g.
<pre>box.pack_start(widget, True, True, 0)</pre>
can be replaced with:
<pre>box.add(widget)</pre>

This is as far as you need to go for now. However, in GTK3, GtkVBox and GtkHBox have been deprecated, which means they might be removed in GTK3. The replacement is to use GtkBox directly, and you may wish to make this change now. e.g.:
<pre>vbox = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)</pre>
<pre>hbox = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL, homogeneous=True, spacing=8)</pre>
However, it must be noted that if GtkBox is used directly (instead of using GtkHBox/GtkVBox), the default value of '''expand''' is now '''False'''. The implications of this are:
# You need to check your .add() calls, as previously they would behave as pack_start with expand=True, but now they will behave as expand=False (you need to change them to use pack_start with expand=True to retain the old behaviour)
# Every single pack_start call that has expand=False and padding=0 (and any value of fill) can be converted to .add() for cleanliness

=== GtkAlignment considerations ===

In PyGTK, the gtk.Alignment constructor takes four optional parameters:
# xalign: the fraction of horizontal free space to the left of the child widget. Ranges from 0.0 to 1.0. Default value 0.0.
# yalign: the fraction of vertical free space above the child widget. Ranges from 0.0 to 1.0. Default value 0.0.
# xscale: the fraction of horizontal free space that the child widget absorbs, from 0.0 to 1.0. Default value 0.0.
# yscale: the fraction of vertical free space that the child widget absorbs, from 0.0 to 1.0. Default value 0.0

In PyGI/GTK3, these parameters are still optional when used in the Gtk.Alignment constructor (as keyword arguments, as explained above). However, the default values have changed. They are now:
# xalign: default value 0.5
# yalign: default value 0.5
# xscale: default value 1
# yscale: default value 1

If your code was relying on the default value of 0 for any of these parameters in PyGTK, you will now need to explicitly specify that in your constructor. Similarly, if you were previously using construction parameters to select the now-default values, those parameters can be dropped.

Additionally, PyGTK accepted these construction parameters as positional arguments. As explained above, they must now be converted to keyword arguments.

=== Gtk Menu Popup ===
The Gtk.Menu.popup function now works slightly differently.
The user supplied positioning function now takes different parameters. These are menu, x, y, push_in and user_data.

=== Gdk ===
Previously, gdk was an attribute of the gtk module, which means that it can be called through gtk. For example, if we want to use color_parse():
gtk.gdk.color_parse(color)
However, what we have to do now is:
from gi.repository import Gdk
Then we can modify the code to the following:
Gdk.color_parse(color)

=== Pango ===
Following the release of Gtk3, we should not be importing pango like this:
import pango
In fact, we can now import pango as an attribute within the gtk3 library:
from gi.repository import Pango as pango
=== Gio.Settings from GConf ===
Any use of GConf should be ported to Gio.Settings.

=== Other considerations ===

''self.allocation'' property is no longer available. Please search your code for "self.allocation" and replace it for "self.get_allocation()".

So to get the allocation size:

self.allocation.width
self.allocation.height

should be replaced by:

self.get_allocated_width()
self.get_allocated_height()

=== Constants ===

Most of the constants have slightly different formats, e.g.,

gtk.STATE_NORMAL became Gtk.StateFlags.NORMAL
gtk.RESPONSE_ACCEPT became Gtk.ResponseType.ACCEPT
gtk.JUSTIFY_CENTER became Gtk.Justification.CENTER
gtk.RELIEF_NONE became Gtk.ReliefStyle.NONE

=== Pixbufs ===

The pixbuf libraies are in their own repository

from gi.repository import GdkPixbuf

GdkPixbuf.Pixbuf.new_from_file()

==Releasing activities (for maintainers)==
Once an activity is ported, a new release can be made. The major version should be greater than the existing one.

Please follow [https://github.com/sugarlabs/sugar-docs/blob/master/src/contributing.md#checklist---maintainer this] guide for releasing a new version

==Port to Python 3==
We are migrating towards Python 3. Python 3 does not support GTK+ 2. Hence, once the activity is ported to GTK+ 3, please also continue porting the activity from Python 2 to Python 3.

Ref: [https://github.com/sugarlabs/sugar-docs/blob/master/src/python-porting-guide.md Guide to port activities to Python 3]

== Tips to Activity Developers ==

===Changes to the Clipboard===
Two things to note:

1. You need to specify a clipboard using get()
clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)
2. You need to pass a length to set_text()
clipboard.set_text(string, len(string))

See [http://python-gtk-3-tutorial.readthedocs.org/en/latest/clipboard.html] for more details.

===Changes to Drag-and-Drop===
Slightly different syntax:
self.drag_dest_set(Gtk.DestDefaults.ALL, [],
Gdk.DragAction.COPY)
self.drag_dest_set_target_list(Gtk.TargetList.new([]))
self.drag_dest_add_text_targets()
self.connect('drag_data_received', self._drag_data_received)

and:
data.get_text()
or:
data.get_image()

See [http://python-gtk-3-tutorial.readthedocs.org/en/latest/drag_and_drop.html] for more details.

===Going from Drawable to Cairo===

GTK-3 does not support gtk Drawable objects, so the first step is to get your activity running under Cairo.

<pre>
import cairo

# From activity.Activity, you inherit a canvas.
# Create a Cairo context from the window.
cairo_context = self.canvas.get_window().cairo_create()

# Create an XLib surface to be used for drawing
xlib_surface = surface.create_similar(cairo.CONTENT_COLOR,
gtk.gdk.screen_width(),
gtk.gdk.screen_height())

# You'll need a Cairo context from which you'll build a GTK Cairo context
cairo_context = cairo.Context(xlib_surface)
cairo_context = gtk.gdk.CairoContext(cairo_context)

# Use this context as you would a Drawable, substituting Cairo commands
# for gtk commands, e.g.,
cairo_context.move_to(0, 0)
cairo_context.line_to(100, 100)
# Cairo uses floats from 0 to 1 for RGB values
cairo_context.set_source_rgb(r, g, b)
cairo_context.rectangle(x, y, w, h)
cairo_context.fill()

# To invalidate a region to force a refresh, use:
self.canvas.queue_draw_area(x, y, w, h)

# Handle the expose event
# "expose" became "draw" for the cairo signal
def do_expose_event(self, event):
# Create the cairo context
cairo_context = self.canvas.get_window().cairo_create()
cairo_context.rectangle(event.area.x, event.area.y,
event.area.width, event.area.height)
cairo_context.clip()
cairo_context.set_source_surface(xlib_surface)
cairo_context.paint()
</pre>

Pango is a bit different when used with Cairo:

<pre>
import pango, pangocairo

# Again, from the xlib_surface...
cairo_context = cairo.Context(xlib_surface)

# Create a PangoCairo context
cairo_context = pangocairo.CairoContext(cairo_context)

# The pango layout is created from the Cairo context
pango_layout = cairo_context.create_layout()

# You still use pango to set up font descriptions.
fd = pango.FontDescription('Sans')
fd.set_size(12 * pango.SCALE)

# Tell your pango layout about your font description
pango_layout.set_font_description(fd)

# Write text to your pango layout
pango_layout.set_text('Hello world', -1)

# Position it within the Cairo context
cairo_context.save()
cairo_context.translate(x, y)
cairo_context.rotate(pi / 3) # You can rotate text and images in Cairo
cairo_context.set_source_rgb(1, 0, 0)

# Finally, draw the text
cairo_context.update_layout(pango_layout)
cairo_context.show_layout(pango_layout)
cairo_context.restore()
</pre>

To draw a bitmap...

<pre>
# Again, from the xlib_surface...
cairo_context = cairo.Context(xlib_surface)

# Create a gtk context
cairo_context = gtk.gdk.CairoContext(cairo_context)
cairo_context.set_source_pixbuf(pixbuf, x, y)
cairo_context.rectangle(x, y, w, h)
cairo_context.fill()
</pre>

To read a pixel from the xlib surface...

<pre>
# create a new 1x1 cairo surface
cairo_surface = cairo.ImageSurface(cairo.FORMAT_RGB24, 1, 1);
cairo_context = cairo.Context(cairo_surface)
# translate xlib_surface so that target pixel is at 0, 0
cairo_context.set_source_surface(xlib_surface, -x, -y)
cairo_context.rectangle(0,0,1,1)
cairo_context.set_operator(cairo.OPERATOR_SOURCE)
cairo_context.fill()
cairo_surface.flush() # ensure all writing is done
# Read the pixel
return (ord(pixels[2]), ord(pixels[1]), ord(pixels[0]), 0)
</pre>

===Going from Cairo in GTK-2 to Cairo in GTK-3===

(See http://developer.gnome.org/pangomm/2.28/annotated.html for more details)
Not much changes, but...

The Cairo/Pango interaction is a little different:
<pre>
from gi.repository import Pango, PangoCairo

cairo_context = ...
pango_layout = PangoCairo.create_layout(cairo_context)
fd = Pango.FontDescription('Sans')
fd.set_size(12 * Pango.SCALE)
pango_layout.set_font_description(fd)
pango_layout.set_text('Hello World', -1)
cairo_context.set_source_rgb(1, 0, 0)
PangoCairo.update_layout(cairo_context, pango_layout)
PangoCairo.show_layout(cairo_context, pango_layout)
</pre>

The get_extents() method if different in PangoCairo. It calculates an extent as a Rectangle, but doesn't return anything. There is a method, get_logical_extents() that returns a Rectangle. Alas, it is not necessarily available after v1.16. Note that Rectangle is not a list but a class with methods for get_x(), get_y(), get_width(), and get_height(), so you cannot iter over it.

Note that the <samp>cairo.Region</samp> will no longer work in Gtk+3

==== Replacing pixmaps with Cairo ====
You need to replace your pixmaps with Cairo in GTK3. See http://developer.gnome.org/gtk3/3.5/ch24s02.html#idp129615008 for example code.

===Taking a screenshot and making a thumbnail===
To make a screenshot of the window:
<pre>
width, height = window.get_width(), window.get_height()
thumb_surface = Gdk.Window.create_similar_surface(window,
cairo.CONTENT_COLOR,
width, height)

thumb_width, thumb_height = style.zoom(100), style.zoom(80)
cairo_context = cairo.Context(thumb_surface)
thumb_scale_w = thumb_width * 1.0 / width
thumb_scale_h = thumb_height * 1.0 / height
cairo_context.scale(thumb_scale_w, thumb_scale_h)
Gdk.cairo_set_source_window(cairo_context, window, 0, 0)
cairo_context.paint()
thumb_surface.write_to_png(png_path_or_filelike_object)
</pre>

===Creating a video widget===

Haven't gotten this working yet, but some necessary changes include:

Instead of
window.xid
use
get_property('window').get_xid()

Instead of
unset_flags(gtk.DOUBLE_BUFFERED)
set_flags(gtk.APP_PAINTABLE)
use
set_double_buffered(False)
set_app_paintable(True)

A more basic question is whether or not we migrate to gstreamer-1.0. If we do, some helpful documentation is found here [https://wiki.ubuntu.com/Novacut/GStreamer1.0].

== Resources ==
PyGI Documentation: https://lazka.github.io/pgi-docs/

gtk2: http://www.pygtk.org/docs/pygtk/
* Reference Manual
:: Gtk3: http://developer.gnome.org/gtk3/3.4/
* Gdk documentation:
:: Gdk3: http://developer.gnome.org/gdk/2.24/
* Pango documentation:
:: GTK3: http://developer.gnome.org/pangomm
* Gst-1.0 documentation
:: Gst-1: http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/index.html
* Gst-1.0 porting hints
:: https://wiki.ubuntu.com/Novacut/GStreamer1.0

[[Category:Developer]]

= More porting wiki pages =

{{Special:PrefixIndex/Features/GTK3/Porting}}

User:Pro-panda

2018-03-21T06:19:41Z

Pro-panda: /* Bio */

== Rahul Bothra ==

=== Bio ===
I am Rahul Bothra, Computer Science sophomore at BITS Pilani, Pilani. I am from India and usually code from 03:30(UTC) to 18:00(UTC). In my free time, I like playing Piano, and learning new algorithms. I am a core member of BITS-ACM (Campus Chapter) at our college, where we conduct lectures and events like Hackathon and workshopos to promote almost all areas of computing.

==== Skills ====
*Python, C, Shell, SQL (Postgres and MySQL) and NoSQL (MongoDB)
*Learnt in coursework: Assembly, Java

==== Areas of Interest ====
Logic Programming and Data Strucutures and Algorithms

==== Future areas for exploration (~6 months) ====
Image Processing and Natural Language Processing

==== Me and Sugar Labs ====
My first contribution to Sugar Labs was working on [https://github.com/sugarlabs/sugar/issues/780 this] issue. Since then I have been contributing regularly by fixing bugs, suggesting ideas and creating and maintaining activities.
; Motivation
: Back in December' 17, when I started to prepare for GSoC 2018, I decided to work for Sugar Labs. My motivation was its idea and the impact it had on the society

; Experience
: My work with Sugar Labs was my first introduction to an Open Source Organisation. I got to learn the workings of a big Open Source project, which is more than just writing code. I was constantly guided by the community, pointing where I went wrong and how to improve myself. Working for Sugar Labs has now become a part of my daily routine and I enjoy doing the same.

==== Contact/Feedback ====
Email: f2016015@pilani.bits-pilani.ac.in

Github: https://github.com/Pro-Panda

I would love to hear suggestions to improve myself, or discuss any ideas.

User:Pro-panda

2018-03-21T06:11:38Z

Pro-panda: /* Bio */

== Rahul Bothra ==

=== Bio ===
I am Rahul Bothra, Computer Science sophomore at BITS Pilani, Pilani. I am from India and usually code from 03:30(UTC) to 18:00(UTC). In my free time, I like playing Piano, and learning new algorithms. I am a core member of BITS-ACM (Campus Chapter) at our college, where we conduct lectures and events like Hackathon and workshopos to promote almost all areas of computing.

==== Skills ====
*Python, C, Shell, SQL (Postgres and MySQL) and NoSQL (MongoDB)
*Learnt in coursework: Assembly, Java

==== Areas of Interest ====
Logic Programming and Data Strucutures and Algorithms

==== Future areas for exploration (~6 months) ====
Image Processing and Natural Language Processing

==== Me and Sugar Labs ====
My first contribution to Sugar Labs was working on [https://github.com/sugarlabs/sugar/issues/780 this] issue. Since then I have been contributing regularly by fixing bugs, suggesting ideas and creating and maintaining activities.
; Motivation
: Back in December' 17, when I started to prepare for GSoC 2018, I decided to work for Sugar Labs. My motivation was its idea and the impact it had on the society

; Experience
: My work with Sugar Labs was my first introduction to an Open Source Organisation. I got to learn the workings of a big Open Source project, which is more than just writing code. I was constantly guided by the community, pointing where I went wrong and how to improve myself. Working for Sugar Labs has now become a part of my daily routine and I enjoy doing the same.

==== Contact/Feedback ====
Email: f2016015@pilani.bits-pilani.ac.in

Github: https://github.com/Pro-Panda

I would love to hear my mistakes/suggestions to improve myself, or discuss any ideas

User:Pro-panda

2018-03-21T06:09:10Z

Pro-panda: User Profile: Rahul Bothra | Pro-Panda

== Rahul Bothra ==

=== Bio ===
I am Rahul Bothra, Computer Science sophomore at BITS Pilani, Pilani. I am from India and usually code from 03:30(UTC) to 18:00(UTC). In my free timme, I like playing Piano, and learning new algorithms. I am a core member of BITS-ACM (Campus Chapter) at our college, where we conduct lectures and events like Hackathon and workshopos to promote almost all areas of computing.

==== Skills ====
*Python, C, Shell, SQL (Postgres and MySQL) and NoSQL (MongoDB)
*Learnt in coursework: Assembly, Java

==== Areas of Interest ====
Logic Programming and Data Strucutures and Algorithms

==== Future areas for exploration (~6 months) ====
Image Processing and Natural Language Processing

==== Me and Sugar Labs ====
My first contribution to Sugar Labs was working on [https://github.com/sugarlabs/sugar/issues/780 this] issue. Since then I have been contributing regularly by fixing bugs, suggesting ideas and creating and maintaining activities.
; Motivation
: Back in December' 17, when I started to prepare for GSoC 2018, I decided to work for Sugar Labs. My motivation was its idea and the impact it had on the society

; Experience
: My work with Sugar Labs was my first introduction to an Open Source Organisation. I got to learn the workings of a big Open Source project, which is more than just writing code. I was constantly guided by the community, pointing where I went wrong and how to improve myself. Working for Sugar Labs has become a part of my daily routine and I enjoy doing the same.

==== Contact/Feedback ====
Email: f2016015@pilani.bits-pilani.ac.in

Github: https://github.com/Pro-Panda

I would love to know my mistakes or any suggestions to improve myself, or discuss any ideas