Difference between revisions of "Activity Team/Creating a New Activity"

Latest revision as of 13:18, 2 December 2014

Documentation for activity authors

See Activity Team/Resources.

Checklist for new activities

Create a GitHub project repository at http://github.com and start hacking on your code! :-)
Request a trac component for your activity at http://bugs.sugarlabs.org/
Open a trac ticket to request addition to http://translate.sugarlabs.org/ (when your strings are mature)
Add your Activity to http://wiki.sugarlabs.org/go/Sugar_on_a_Stick/Roadmap if you want to be on the SoaS distro

If your Activity is migrating over from the OLPC infrastructure, see: How to migrate from OLPC.

When releasing an existing Activity

If you have one, update your wiki page at http://wiki.sugarlabs.org/go/Activities/<actvity-name>
Upload your new .xo bundle, screenshots, notes to http://activities.sugarlabs.org/
Unless your source code is already available through git, upload a .bz2 source tarball to shell.sugarlabs.org /upload/sugar/sources/honey (e.g., scp to download.sugarlabs.org:/srv/upload/sources/fructose/...)
Edit http://wiki.sugarlabs.org/go/Development_Team/Source_Code and make sure it's pointing to your latest source tarball

Before you write a new activity

Do you have an idea for a new Activity you'd like to write but don't know how to begin? Here's some advice:

Don't try to write a Sugar Activity right away. Instead, write a standalone Python program that does what you want, then convert it to a Sugar Activity, being sure to keep a copy of the non-Sugarized version around for future use. There are several reasons for this, but the chief one is that standalone programs are easier to test, especially if you are not currently a Linux user. A standalone Python program can run anywhere, but a Sugar Activity really needs Sugar running on top of Linux. You can run your standalone Python program on an XO using the Terminal Activity.

When I add new features to my Sugar Activities I generally try to get the feature working on the standalone version first. I did this with text to speech in Read Etexts, for instance. This was useful because when I ran into problems I had a standalone app I could send to the speech-dispatcher mailing list so they could easily recreate my problem.

You'll want a good code-highlighting editor that understands Python. A couple of good ones:

These are a bit more complicated to install than typical Windows programs. They are included in every Linux distribution, though.

To make and test a Sugarized Activity you really should have a Linux distribution installed. The best for this purpose is probably Fedora, which includes the latest Sugar environment, eric, gedit, Python, pygame, PyGTK, a tool for making SVG icons, and lots of other useful stuff. You can run Linux on the same computer as Windows (by partitioning your hard drive, something the Fedora installer will do for you) and choose which one you want to run at boot time. Fedora is no more difficult to install than Windows is, even if you want to run it and Windows on the same machine, and will run on hardware that would be inadequate for current versions of Windows. A Pentium III with 256 meg of RAM and a few gig of hard disk is more than adequate for Sugar development.

If you don't want to have anything to do with Linux, you could make a standalone Python program and find a collaborator to Sugarize it for you. You could also attempt to develop your Activity using Sugar on a Stick, or an actual XO, but this would probably be more trouble than simply installing Fedora 10.

Feel free to ignore any of this advice if it doesn't seem applicable. I hope that you'll find it gives you a place to start.

Additional tips and common "gotchas"

Don't use punctuation in your bundle_id, e.g. org.sugarlabs.my-activity-name is not a valid bundle name. Use CamelCase instead: org.sugarlabs.MyActivityName
Follow the Rainbow guidelines.

On OLPC-XOs, you can test with Rainbow disabled by removing /etc/olpc-security

rm /etc/olpc-security

Reënable Rainbow by touching /etc/olpc-security

touch /etc/olpc-security

@@ Line 1: / Line 1: @@
-For new Activities:
+== Documentation for activity authors ==
-    Create a Gitorious project repository at http://git.sugarlabs.org/ and start hacking on your code! :-)
-    Request a trac component for your activity at http://dev.sugarlabs.org/
-    Open a trac ticket to request addition to Pootle our translation system (if your strings are mature)
-    Add your Activity to http://wiki.sugarlabs.org/go/Sugar_on_a_Stick/Roadmap if you want to be on the SoaS distro
-Do you have an idea for a new Activity you'd like to write but don't know how to begin?  Here's some advice:
+See [[Activity Team/Resources]].
-).  Don't try to write a Sugar Activity right away.  Instead, write a standalone Python program that does what you want, then convert it to a Sugar Activity, being sure to keep a copy of the non-Sugarized version around for future use.  There are several reasons for this, but the chief one is that standalone programs are easier to test, especially if you are not currently a Linux user.  A standalone Python program can run anywhere, but a Sugar Activity really needs Sugar running on top of Linux.  You can run your standalone Python program on an XO using the Terminal Activity.
+== Checklist for new activities ==
-When I add new features to my Sugar Activities I generally try to get the feature working on the standalone version first.  I did this with text to speech in Read Etexts, for instance.  This was useful because when I ran into problems I had a standalone app I could send to the speech-dispatcher mailing list so they could easily recreate my problem.
+* Create a GitHub project repository at http://github.com and start hacking on your code! :-)
+* Request a trac component for your activity at http://bugs.sugarlabs.org/
+* Open a trac ticket to request addition to http://translate.sugarlabs.org/ (when your strings are mature)
+* Add your Activity to http://wiki.sugarlabs.org/go/Sugar_on_a_Stick/Roadmap if you want to be on the SoaS distro
-).  Sugar Activities are generally made with pygtk or pygame, and I believe pygtk is the more common of the two.  These are both cross platform and have online tutorials, as does Python itself:
+* If your Activity is migrating over from the OLPC infrastructure, see: [[Activity_Team/How_to_migrate_from_OLPC|How to migrate from OLPC]].
-* http://www.python.org/
+== When releasing an existing Activity ==
-* http://www.pygtk.org/
-* http://www.pygame.org/news.html
-).  You'll want a good code-highlighting editor that understands Python.  A couple of good ones:
+* If you have one, update your wiki page at http://wiki.sugarlabs.org/go/Activities/<actvity-name>
+* Upload your new .xo bundle, screenshots, notes to http://activities.sugarlabs.org/
+* Unless your source code is already available through git, upload a .bz2 source tarball to shell.sugarlabs.org /upload/sugar/sources/honey (e.g., scp to download.sugarlabs.org:/srv/upload/sources/fructose/...)
+* Edit http://wiki.sugarlabs.org/go/Development_Team/Source_Code and make sure it's pointing to your latest source tarball
-* Eric: http://eric-ide.python-projects.org/eric4-download.html
+== Before you write a new activity ==
-* Gedit: http://projects.gnome.org/gedit/
-These are a bit more complicated to install than typical Windows programs.  They are included in every Linux distribution, though.
+Do you have an idea for a new Activity you'd like to write but don't know how to begin?  Here's some advice:
-).  To make and test a Sugarized Activity you really should have a Linux distribution installed.  The best for this purpose is probably Fedora 10, which includes the Sugar environment, eric, gedit, python, pygame, pygtk, a tool for making SVG icons, and lots of other useful stuff.  You can run Linux on the same computer as Windows XP (by partitioning your hard drive, something the Fedora installer will do for you) and choose which one you want to run at boot time.  Fedora 10 is no more difficult to install than Windows is, even if you want to run it and Windows on the same machine, and will run on hardware that would be inadequate for current versions of Windows.  A Pentium III with 256 meg of RAM and a few gig of hard disk is more than adequate for Sugar development.
+* Don't try to write a Sugar Activity right away.  Instead, write a standalone Python program that does what you want, then convert it to a Sugar Activity, being sure to keep a copy of the non-Sugarized version around for future use.  There are several reasons for this, but the chief one is that standalone programs are easier to test, especially if you are not currently a Linux user.  A standalone Python program can run anywhere, but a Sugar Activity really needs Sugar running on top of Linux.  You can run your standalone Python program on an XO using the Terminal Activity.
-The Sugar environment that comes with Fedora 10 should be adequate for creating Activities.  It is not the latest version of Sugar, but keep in mind that most XO laptops won't be running the latest Sugar either.
+When I add new features to my Sugar Activities I generally try to get the feature working on the standalone version first.  I did this with text to speech in Read Etexts, for instance.  This was useful because when I ran into problems I had a standalone app I could send to the speech-dispatcher mailing list so they could easily recreate my problem.
-If you don't want to have anything to do with Linux you ''could'' make a standalone Python program and find a collaborator to Sugarize it for you.  You could also attempt to develop your Activity using Sugar on a Stick, or an actual XO, but this would probably be more trouble than simply installing Fedora 10.
+* You'll want a good code-highlighting editor that understands Python.  A couple of good ones:
+:* Eric: http://eric-ide.python-projects.org/eric4-download.html
+:* Gedit: http://projects.gnome.org/gedit/
+:These are a bit more complicated to install than typical Windows programs.  They are included in every Linux distribution, though.
-).  When you are ready to Sugarize your Python program, read these articles:
+* To make and test a Sugarized Activity you really should have a Linux distribution installed.  The best for this purpose is probably Fedora, which includes the latest Sugar environment, eric, gedit, Python, pygame, PyGTK, a tool for making SVG icons, and lots of other useful stuff.  You can run Linux on the same computer as Windows (by partitioning your hard drive, something the Fedora installer will do for you) and choose which one you want to run at boot time.  Fedora is no more difficult to install than Windows is, even if you want to run it and Windows on the same machine, and will run on hardware that would be inadequate for current versions of Windows.  A Pentium III with 256 meg of RAM and a few gig of hard disk is more than adequate for Sugar development.
-* http://wiki.sugarlabs.org/go/Development_Team/Almanac
+* If you don't want to have anything to do with Linux, you ''could'' make a standalone Python program and find a collaborator to Sugarize it for you.  You could also attempt to develop your Activity using Sugar on a Stick, or an actual XO, but this would probably be more trouble than simply installing Fedora 10.
-* http://wiki.laptop.org/go/Beyond_Hello_World
 Feel free to ignore any of this advice if it doesn't seem applicable.  I hope that you'll find it gives you a place to start.