=== ChanServ changed the topic of #ubuntu-classroom to: Welcome to the Ubuntu Classroom - http://wiki.ubuntu.com/Classroom || Support in #ubuntu || Upcoming Schedule: http://is.gd/8rtIi || Current Session: NBS and how to keep the archive fresh - Instructor: persia || Questions in #ubuntu-classroom-chat === ChanServ changed the topic of #ubuntu-classroom to: Welcome to the Ubuntu Classroom - http://wiki.ubuntu.com/Classroom || Support in #ubuntu || Upcoming Schedule: http://is.gd/8rtIi === mohi_away is now known as mohi1 [16:58] dpm about set? [16:58] jono, ready to roll [16:58] you rock :) [16:59] #community rocks! [16:59] :) === ChanServ changed the topic of #ubuntu-classroom to: Welcome to the Ubuntu Classroom - http://wiki.ubuntu.com/Classroom || Support in #ubuntu || Upcoming Schedule: http://is.gd/8rtIi || Event: Ubuntu Opportunis tic Developer Week - Current Session: Hot rodding your app for translations support - David Planella - Instructor: dpm || Questions in #ubuntu-classroom-chat [17:00] hello everybody! [17:01] Welcome to today's first session of Ubuntu Opportunistic Developer Week [17:02] let's just wait a couple of minutes, to see that everyone gets here... [17:03] I should also remind you that today is a snippets day [17:03] of which you'll find all details here: https://wiki.ubuntu.com/PythonSnippets [17:04] There'll also be a snippets party in #ubuntu-app-devel later, so be sure to join the fun! [17:04] Anyway, without further ado... [17:04] [SLIDE 1] [17:05] Welcome to this session on Hot rodding your application for translations support [17:06] In the next hour we'll talk on how to get your app ready to speak a multitude of languages [17:06] and set up so that our awesome translation teams can do their work [17:06] For those who are not using Lernid, here's a direct link to the slides in this session: http://people.ubuntu.com/~dpm/Quickly-i18n.pdf [17:07] This talk will be based on quickly as the framework to opportunistically create your application in no time [17:08] parts of the talk were contributed by didrocks, Didier Roche, who's the main quickly developer [17:08] Let's start having a quick look at the main players involved in the internationalization game: [17:09] [SLIDE 2] [17:09] == GNU Gettext == [17:09] Gettext is the underlying and most widely used technology to enable translations of Open Source projects. [17:09] It defines a standard format of translation files translators can do their work with (PO files) [17:09] and lets applications load those translations compiled in a binary format (MO files) at runtime. [17:10] It has implementations for many programming languages, and amongst them, of course, Python. [17:10] You'll find that the comprehensive gettext manual at http://www.gnu.org/software/gettext/manual/gettext.html can be a very useful reference, [17:10] The Python implementation of the gettext API is what we'll use to internationalize our project with Quickly today. [17:11] Needless to say, it also comes with some nifty documentation at http://docs.python.org/library/gettext.html [17:11] == intltool == [17:11] Intltool is a higher level tool that adds functionality to gettext by allowing the extraction of translatable strings from a variety of file formats [17:11] It has also become a standard tool when implementing internationalization for OSS projects. Nearly all (if not all) GNOME projects, for example, use intltool. [17:12] == python-distutils-extra == [17:12] Python-distutils-extra is a python package that makes it easy to integrate themable icons, documentation and gettext based translations in your python install and build tools, and it's basically an enhancement to python-distutils. [17:12] The project's page is at http://www.glatzor.de/projects/python-distutils-extra/ [17:12] The three above technologies (gettext, intltool, python-distutils-extra) are transparently used by quickly, so we won't get into much more detail for now. [17:13] There are also more aspects involved in internationalizing applications, such as font rendering, input methods, etc., but this should get you started for now. [17:13] == Quickly == [17:14] I'll be very brief here and let you figure out more on quickly as we go along [17:14] For now, it will suffice give you a teaser and tell you that it is the tool which brings back the fun in writing applications! [17:14] == Launchpad Translations == [17:15] Launchpad Translations ( https://translations.launchpad.net/ ) is the collaborative online tool which allows translation communities to be brought together and translate applications online through its web UI. [17:15] Apart from the very polished UI to provide translations, it has other nice features such as message sharing across project series (translate one message in a series and it instantly propagates to all other shared series), [17:15] global suggestions (suggestions of translations across _all_ projects in Launchpad), automatic imports of translations and automatic commits to bzr branches, several levels of permissions, and a huge translator base. [17:16] On the right hand side of the URL I gave you you can see that there are quite a lot of projects using Launchpad to make translations easy both for developers and translators. [17:16] Ok, enough theory, let's have a go at using quickly to create your first internationalized application [17:17] You can install Quickly on Karmic or Lucid simply by executing 'sudo apt-get install quickly' [17:18] or if you are brave, you can try the trunk version (bzr branch lp:quickly) [17:18] let's focus on the stable version, though [17:19] [SLIDE 3] [17:19] You should see an overview of quickly here [17:20] Quickly has two parts: the core, which basically parses your input and templates. [17:20] Templates are sets of commands and code generators that are designed to work together in an end to end fashion to help developers write a certain kind of application. [17:21] with templates, you can then create application or document set. [17:21] We'll focus there only on i18n with the first template that Quickly 0.2 provides: ubuntu-project (renamed ubuntu-application on the coming 0.4 release!) [17:21] (this template is using Glade, couchdb, has some nice trick for gedit, use bzr, and complete integration with LaunchPad and debian packaging) [17:22] For instance, Lernid that some of you may be using, was created with the ubuntu-project template. (http://www.jonobacon.org/?p=2258 for a shot of the story) [17:22] [SLIDE 4] [17:22] So, let's create first a simple ubuntu-project (assuming you are using Quickly 0.2, the stable version): [17:22] You can run this: [17:22] quickly create ubuntu-project fooby [17:23] this tells Quickly to use the ubuntu-project template, and to call what is created "fooby" [17:23] This causes a bunch of info to be dumped to the command line, but ends with the application being run [17:23] What Quickly did was to copy over basically a sample application, and do some text switcheroos to customize the app [17:23] You can see there the ui which contains some text that needs translation. [17:23] To start making change to your app, cd to it (normally, [17:24] cd fooby [17:24] You can then edit your code with $ quickly edit, change the UI with $ quickly glade, and try your changes with $ quickly run [17:24] You can save your change with $ quickly save [17:24] changes [17:25] Finally, to package, share, release your apps so that other will be, with the following commands (not all are necessary): $ quickly package / $ quickly share / $ quickly release [17:25] I won't cover in any more detail Quickly or the ubuntu-project template here (quickly help does this for you), [17:26] you can find more info at: https://wiki.ubuntu.com/MeetingLogs/devweek0909/QuicklyFun [17:26] Let's see what you can do in "quickly edit" and "quickly glade": adding internalization support to your app [17:26] As the project stands now, it has the infrastructure for internationalization in place, but we have to initialize it to enable it. [17:27] This will include: [17:27] * Initializing gettext [17:27] * Marking strings for translation [17:27] * Updating the translation template [17:28] [SLIDE 5] [17:28] First of all, we'll initialize gettext, which will basically be adding four lines of code. Here's how it goes: [17:28] quickly edit [17:28] This will open all your project files in a text editor (Gedit by default) [17:28] 1. Go to the fooby file and add the following two lines below 'import gtk', near the top of the file: [17:28] import gettext [17:28] import locale [17:29] This will import the required modules for internationalization [17:29] 2. Still on the fooby file, add the following line below the 'import logging, optparse' one, near the end of the file: [17:29] gettext.install('fooby', unicode=True) [17:29] This will install the _() function to mark (and call) translations as such in Python's builtins namespace, based on the 'fooby' domain. The domain basically tells gettext where to load translations from. [17:30] This will also save you to include 'import gettext' statements in all of your project files using gettext. This will do for your first application [17:30] Refer to the gettext documentation to find out more about translation domains. [17:30] 3. Finally, add the following line to 'fooby', before the 'builder = gtk.Builder()' line [17:30] locale.textdomain('fooby') [17:30] This will tell GtkBuilder about the translation domain as well [17:31] So that was it! Let's move on to marking strings for translation: [17:31] First of all we'll tackle the .destop file [17:31] Open the fooby.desktop.in file and prepend the Name and comment fields with an underscore (_), so they look like: [17:31] _Name=Fooby [17:31] _Comment=Fooby application [17:32] This will tell intltool that this strings contain translations [17:32] Next comes the UI. Let's see how you can mark strings in the UI for translation. Try: [17:32] quickly glade [17:32] This will open your UI files in the glade editor. [17:32] Once opened, click on the "Your application has been created! ..." label, find it in the General > Label field on the right, click on the ellipsis (the three dots) button and... [17:33] amaze at the fact that it has already been marked as "Translatable", so you won't have to do anything. [17:33] Right, so next comes something very important that you'll have to bear in mind for all strings you'd like to be translatable in your application: [17:33] * using the _() function call. [17:33] This will mark them as translatable and call gettext to load the translations, and should be used for all messages you'd like to present to users. [17:34] Let's just see how we can do this. [17:34] Go back to your fooby file and find the "parser.add_option("-v", "--verbose", action="store_true", dest="verbose", help="Show debug messages")" line near the bottom. [17:34] We want the "Show debug messages" message to get shown to users in their language, so we'll enclose it with the _() function, and it will look like: [17:34] parser.add_option("-v", "--verbose", action="store_true", dest="verbose", help=_("Show debug messages")) [17:35] Now we're done [17:35] The last part will be to update the translations template. [17:35] A translations template is a formatted text file generally named yourproject.pot [17:35] which contains your project's translatable strings in English and is what translators use as a basis for their translations. [17:36] You should do this at least before each release, so that translations are put in this template and are up-to-date for translators to work on. [17:36] It is considered good practice to announce a string freeze (that is, the period in which strings are considered to be stable) a week or two before the release, so that translators know when they can start their work. [17:36] This can be done in several ways with quickly, let's pick one: [17:36] quickly package [17:37] After running this, you'll notice that (apart from having your application packaged!) there is a 'po' folder containing the translation template, ready for translators to work on. [17:37] If you open it, you'll notice the format and will see that all the strings you marked for translation are there. [17:37] You can also do this with 'quickly share', 'quickly release' or directly using the python-distutils-extra command: './setup.py build_i18n' [17:37] == Launchpad Translations == [17:38] If this weren't awesome enough, once you've created a project in Launchpad ('quickly share', 'quickly release' or https://help.launchpad.net/ will help you on that) you can expose it for the world to translate [17:38] so that you as a developer can use the automatic bzr import/export features to basically "forget" about translations and translators can use the web UI to translate. [17:39] Let me tell you a bit more on those: [17:39] [SLIDE 6] [17:39] == Automatic imports == [17:39] Enabling this feature will allow you to automatically import the translation template for your application into Launchpad upon commit, with no further steps required. [17:39] So the basic workflow will be: hack, hack, hack, update template, commit, have translators automagically see the new strings in Launchpad. [17:40] You can find more about this at http://blog.launchpad.net/translations/import-translation-templates-from-your-projects-bazaar-branches and http://blog.launchpad.net/general/trying-out-launchpad-translations [17:40] or at http://blog.launchpad.net/translations/screencast-importing-translation-templates-from-a-bazaar-branch [17:40] == Automatic exports == [17:41] With automatic exports, you'll be able to complete the whole circle for automation: getting translations committed automatically (daily) to a bzr branch of your choice, so that neither you nor translators have to worry to get translations into your project. [17:41] I personally find this one of the most coolest features [17:41] Here's more info: http://blog.launchpad.net/general/exporting-translations-to-a-bazaar-branch [17:41] And here's a screencast on how to enable it http://blog.launchpad.net/translations/screencast-exporting-translations-to-a-bazaar-branch [17:42] == Permissions == [17:42] One very important aspect is how you want translations permissions for your project to be. This basically means choosing who will be responsible for submitting and reviewing those [17:42] translations for each language. [17:42] Launchpad is flexible in allowing different levels of openness for translating your project. [17:43] This generally means that you as a maintainer will have to make a decision to balance openness (open translations for everyone) with quality control (a more closed process with reviewers and a QA workflow). [17:43] The Launchpad help page on permissions at https://help.launchpad.net/Translations/YourProject/PermissionPolicies explains very well the different permissions you can use (Open, Structured, Restricted and Closed). [17:43] If you decide for quality, you'll next have to choose to whom you assign the translation of your project. [17:43] Here is where translation groups come to the rescue. [17:44] Translation groups are confederations of translation teams, one for each language you can assign as a pack to translate your project. [17:44] The teams in those groups are considered to be trusted to have experience with translations and generally have a review process in place. [17:44] Here's a list of all current translation groups: https://translations.launchpad.net/+groups [17:44] You can see that the two biggest ones are Launchpad Translators and Ubuntu Translators. [17:45] While you can create a translation group specific to your project, we generally encourage maintainers to choose one of the existing ones, [17:45] in order to reuse the pool of translators and not to further fragment translations communities. [17:45] I personally recommend choosing Restricted (or Structured), assigned to the trusted Launchpad Translators or Ubuntu Translators (if your project is Ubuntu-specific) translations groups [17:45] [SLIDE 7] [17:46] I'll rapidly go through quickly's incoming features and then we can do some Q&A [17:46] Quickly 0.4 will bring a lot of new experiences and commodities to the users (more than 200 commits, 6 months of hard work!) and will be delivered in Lucid. [17:47] Regarding internationalization, all the tedious job of importing/initalizing gettext and adding _() will be done for you in all newly created apps. [17:47] "$ quickly add pythonfile" will also add one boiler plate file containing that for you. [17:47] Quickly 0.6 later on will try to achieve the automatic imports and exports previously described on each $ quickly share / $ quickly release command. [17:48] So, normally, you won't have to bother anymore about localization and being in sync with the awesome work of your contributors [17:48] just mark strings with _() [17:48] So that was it! [17:48] Questions? [17:51] QUESTION: How does one get the translation files for each language from the .pot file? [17:51] That's usually the work of translators [17:51] when you've committed the .pot file to your bzr branch, and it is exposed in Launchpad with automatic imports [17:52] translators will see the translatable strings in Launchpad and start doing their work [17:53] if you've got automatic exports activated, the PO files will be created for you whenever there is a new translation, and committed to your branch of choice [17:53] So, in short, as a maintainer this will happen automagically for you :) [17:54] keep them coming :) [17:55] O I see, gnunerz is asking: [17:55] QUESTION: I get that... I'm just curious as to how does the manual process goes :) [17:56] if you were not using Launchpad, you'd announce that there is a new POT file available, and translators would fetch it, create a PO file containing the translation for their language, and would send it back to you [17:56] The same process: translators always take care of translations, but with a bit more manual work for all people involved [17:57] So, in shourt, I'd recommend using Launchpad and automatic import/export [17:57] QUESTION: It is possible to define which languages I want my app be translated to? [17:58] No, in general you want your application to be available in as many languages as possible, and Launchpad allows translating in almost any language [17:58] You might be able to limit which translations are build in your project's build infrastructure [17:59] But you'll have to explicitly set it up to use just some of the translations [17:59] QUESTION: Does this process also take care of locale stuff, like how is the date presented to the users? [17:59] in general, yes [18:00] but we'd need another session to go into the details :) [18:00] basically, the app must set up the locale settings right on initialization === ChanServ changed the topic of #ubuntu-classroom to: Welcome to the Ubuntu Classroom - http://wiki.ubuntu.com/Classroom || Support in #ubuntu || Upcoming Schedule: http://is.gd/8rtIi || Event: Ubuntu Opportunistic Developer Week - Current Session: Learning through examples with Acire and Python-Snippets - Jono Bac - Instructor: jono || Questions in #ubuntu-classroom-chat [18:01] :) [18:01] alrighty [18:01] thanks dpm [18:01] isn't that man such a freaking rock star?! [18:01] everyone needs to give him a hug in #ubuntu-classroom-chat :) [18:01] * jono hugs dpm [18:01] hi everyone and welcome to the python snippets session at Ubuntu Opportunistic Developer Week! [18:02] how are we all doing today? [18:02] the focus of this session is some work I have been doing recently around building a library of python snippets and (a) how this library can be useful for you as an opportunistic developer, but also (b) how you contribute to it to make it an even better resource! [18:03] so, let's get started [18:03] I have always been the kind of person who learns via examples [18:03] when I started learning the guitar, I learned by watching other guitarists play, and when I started learning Python and how to build apps on Ubuntu, I have always learned by hunting out little source code examples that do what I need to do and then learning from them and merging them into my programs [18:04] the problem is that these snippets were scattered all over the Internet and sometimes pretty hard to find [18:04] my dream was to have a program that would bring these snippets together into a library so that I could select them, run them and learn from them [18:05] well, on a flight home from England at Christmas, armed with those small bags of peanuts and a few gin and tonics, I decided to write this little program and it is called Acire, named after my wife's name backwards (Erica) [18:05] Acire is a really simple program that provides an interface to this library of snippets [18:06] let's look at how it works [18:06] check out http://farm5.static.flickr.com/4045/4406908674_2934c4d5c0_o.jpg [18:06] this is a screenshot of the main Acire interface [18:06] in the top-left part of the window there is a drop-down combo box that lists a series of categories of different snippets [18:07] when you select a category, the list of snippets that are in that category are listed below [18:07] in the screenshot you can see the list of snippets that are in the Python Core category: that is, snippets that demonstrate features in the main Python language [18:07] to see a snippet you just click on it and it appears in the code view to the right, all nicely syntax highlighted so you can read it easily :-) [18:08] running the snippet is simple, just click on the Execute button [18:08] how come i don't have python core in my acire ? [18:09] we had a few out of date python-snippets packages - you might have an old package [18:09] embedded in the window is a little terminal view: this is important for snippets that don't have a GUI (such as the Python Core snippets) - if you select a GUI snippet the window will appear when you click the Execute button [18:09] running the snippet gives you a good chance to play with it and see how it works and then take a look at the snippet code in the window [18:10] another feature is that you can edit the snippet code and when you hit Execute it will run your modified program too: this makes it really easy to play with the snippet inside Acire itself - you can then click the Save As button and save the code somewhere else if you like [18:10] we already have a bunch of snippets in Acire: 104 right now (as you can see in the status bar) [18:11] here is the current list of categories [18:11] http://farm5.static.flickr.com/4050/4406908744_d75cbac80f_o.jpg [18:11] if you are curious what my wallpaper is, it is the most awesome duck ever - http://www.flickr.com/photos/w9ned/3563985252/sizes/l/in/pool-1058695 :-) [18:12] anyway, back to the screenshot: http://farm5.static.flickr.com/4050/4406908744_d75cbac80f_o.jpg [18:12] as you can see, it is pretty cool: it provides a really nice resource for looking at a bunch of python examples and it helps you to learn quickly and easily and solve problems right away [18:13] let me now explain how to get it [18:13] I have deliberately split the actual python snippets from the graphical interface - this was because many people may want to produce viewers for the snippets (e.g. a KDE version, a web interface etc) so I did not want to depend on the GUI [18:13] as such, we have two projects: [18:14] acire - the graphical interface to the snippets available at http://www.launchpad.net/acire [18:14] python-snippets - the library of snippets available at http://www.launchpad.net/python-snippets [18:14] the first thing we want to grab are the snippets [18:15] part of my goal here is to make sure that the library of snippets is regularly updated as more snippets are made available [18:15] how can i get the latest version of acire? [18:15] I will explain in just a moment :) [18:15] fortunately, we have an awesome technology for doing this - Personal Package Archives (PPA) - a place in which you can subscribe to a package and you get regular updates [18:16] is acire going to be available in Lucid? [18:16] it runs on Lucid now :) [18:16] so, we have a PPA that generates a daily package of the latest python-snippets library [18:17] ryanprior, nope, what was it? [18:17] QUESTION: can we add snippets in languages other than Python? === yofel_ is now known as yofell [18:17] no, Acire and python-snippets is focused on Python [18:18] although I would love to see other languages have a similar project :) [18:18] so, we have a PPA that generates a daily package of the latest python-snippets library [18:18] adding the PPA is simple, just click Applications -> Accessories -> Terminal and add these commands: [18:18] sudo add-apt-repository ppa:python-snippets-drivers/python-snippets-daily [18:18] sudo apt-get update [18:18] sudo apt-get install python-snippets [18:19] this will add the snippets to /usr/share/python-snippets [18:19] you now need to install Acire to view them [18:19] we also have a PPA for this too [18:20] I recently kicked out a new release, but I haven't had a chance to provide a Karmic package yet, so the new release is just in Lucid right now - the PPA still has the older release though, so this still works [18:20] just follow these steps: [18:20] click Applications -> Accessories -> Terminal (or use the Terminal in Lernid!) and add these commands: [18:20] sudo add-apt-repository ppa:acire-team/acire-releases [18:20] sudo apt-get update [18:20] sudo apt-get install acire [18:21] all of the instructions for doing this are on https://wiki.ubuntu.com/PythonSnippets [18:21] ok, so let's now get to the question about running the latest bleeding edge Acire [18:21] some of you may want to grab the latest code for Acire and run it - this is also really simple, just follow these commands: [18:22] click Applications -> Accessories -> Terminal (or use the Terminal in Lernid!) and add these commands: [18:22] first install all the packages requires to run it: [18:22] sudo apt-get install bzr python-desktopcouch-records python-gconf python-gtk2 python-gtksourceview2 python-vte quickly [18:22] this will grab everything you need [18:22] it may take a little while to grab everything, but not too long :) [18:23] :'( no amd64 [18:23] yeah, but the 32-bit version should run I imagine [18:23] or you can follow these instructions [18:23] ok [18:23] first install all the packages requires to run it: [18:23] sudo apt-get install bzr python-desktopcouch-records python-gconf python-gtk2 python-gtksourceview2 python-vte quickly [18:23] next, let's grab the code [18:23] again, this is really simple thanks our pal, bzr: [18:23] just type in: [18:23] bzr branch lp:acire [18:24] this will grab the latest acire code from Launchpad [18:24] when it has got the code, now enter the directory: [18:24] cd acire [18:24] and then run it: [18:24] quickly run [18:25] A few broken dependencies in Karmic :( [18:25] yeah we had a few issues with dependencies, but you can solve them by making sure you run this line: [18:25] sudo apt-get install bzr python-desktopcouch-records python-gconf python-gtk2 python-gtksourceview2 python-vte quickly [18:25] that will get everything you need [18:25] and you obviously need to ensure the python-snippets PPA is installed, as I described above [18:25] :) [18:26] this will then get you up and running :) [18:26] awesome to see you folks getting it up and running :) [18:26] now, today is an exciting day as we are really keen to encourage you folks to join us in making a bunch of python snippets today to add to the library [18:27] this resource is only as useful as the snippets inside it, so I am really keen to crowdsource this and have any many people as possible join in and contribute snippets [18:27] right now we have 104 snippets [18:27] my dream for today is that we hit the 150 mark :) [18:27] you folks interested in helping? [18:27] interesting in helping to make this rock? [18:27] :) [18:27] we welcome snippets on *any* python module [18:28] so if you can do *something* in python, you could write a snippet [18:28] whether it is as simple as doing something to a list or using a module such as feedparser [18:28] QUESTION: should snippets for a given package (like PyGTK for example) live in python-snippets, or in pythin-gtk2-doc, or where? [18:29] great question ryanprior [18:29] let me explain how the snippets are organized [18:30] ok [18:30] take a look at http://bazaar.launchpad.net/~jonobacon/python-snippets/trunk/files [18:30] this is a list of the content in the main python-snippets archive right now [18:30] as you can see, there are a bunch of directories [18:31] each directory refers to a particular python module [18:31] as an example, the gstreamer dir has snippets that use the GStreamer multimedia framework [18:32] This seems like a great opportunity for upstream involvement. We can help people with their documentation. [18:32] exactly! :) [18:32] inside each dir lives the snippets [18:32] so if we click on the gwibber dir: [18:32] http://bazaar.launchpad.net/~jonobacon/python-snippets/trunk/files/head:/gwibber/ [18:32] there is one snippet [18:33] gwibber is a python module that ships in Lucid that allows you to microblog right from your app [18:33] so the snippet we have is sendmessage.py [18:33] you can see it at http://bazaar.launchpad.net/~jonobacon/python-snippets/trunk/annotate/head:/gwibber/sendmessage.py [18:33] and that explains how in just a few lines of Python you can tweet, dent, Facebook etc [18:34] so in a nutshell the library of snippets is in /usr/share/python-snippets and in there are subdirs, each of which refers to a python module, and the snippets about that module live in there [18:34] so let me explain how a snippet is mad [18:34] made [18:35] a snippet is just a piece of code that demonstrates something [18:35] but what allows us to categorize and show it in Acire are some comments at the top [18:35] let's use http://bazaar.launchpad.net/~jonobacon/python-snippets/trunk/annotate/head:/gwibber/sendmessage.py as an examoke [18:35] example [18:35] the comments with 'SNIPPET' in them are what Acire uses for index and show them [18:35] here are the different lines: [18:35] [SNIPPET_NAME: Send a message] [18:36] this is the text that appears in the sidebar when you have select a snippet category [18:36] a short, sharp description of the snippet [18:36] [SNIPPET_CATEGORIES: Gwibber] [18:36] this is a tag for the snippet [18:36] this is the category that appears in the drop-down box [18:37] snippets can have multiple categories separated by commas if needed [18:37] we have a main list of categories in the CATEGORIES file in the main /usr/share/python-snippets dir [18:37] [SNIPPET_DESCRIPTION: Send a message using the Gwibber API] [18:37] this is the description that appears under the code - a longer description of what the snippet does [18:38] [SNIPPET_AUTHOR: Jono Bacon ] [18:38] this is who wrote it with their email address [18:38] [SNIPPET_LICENSE: GPL] [18:38] and this is the license [18:38] again, a standard set of licenses are in the LICENSES file in /usr/share/python-snippets [18:38] I am happy to accept snippets into the library so long as they use a recognized free software license [18:39] so created a snippet is simple: [18:39] 1. pick which dir it should be in (or create a new one if your snippet is the first for a given python module) [18:39] 2. write the snippet [18:39] 3. include these comments at the top [18:39] 4. submit it :) [18:40] submitting a snippet is explained on https://wiki.ubuntu.com/PythonSnippets [18:40] so today we are having a snippets part [18:40] party [18:41] this is a session in #ubuntu-app-devel where I am encouraging folks to submit snippets for inclusion :) [18:41] so this is a great opportunity to join and get involved and share your knowledge [18:41] the snippets party takes place at 9pm UTC [18:42] and will go on for a few hours, so do come along and join us - it is really cool seeing a snippet that you made show up in the library for everyone to learn from [18:42] do you folks want me to explain how you contribute a snippet? [18:43] ok cool :) [18:43] so first run: [18:43] bzr branch lp:python-snippets [18:43] this will grab the python-snippets library [18:43] now go in and add your snippet [18:43] you can add it to an existing directory in there if the snippet is about one of those topics [18:44] or feel free to create a new dir for a python module that is not covered in the library yet [18:44] when you create your snippet make sure you have the comments at the top of the file [18:44] e.g: [18:44] # [SNIPPET_NAME: Playing a Pipeline] [18:44] # [SNIPPET_CATEGORIES: GStreamer] [18:44] # [SNIPPET_DESCRIPTION: Construct and play a pipeline] [18:44] # [SNIPPET_AUTHOR: Jono Bacon ] [18:44] # [SNIPPET_LICENSE: GPL] [18:44] i'm seriously learning a lot this week. contributing as a developer actually seems possible now. [18:44] that is awesome! :D [18:45] when you have added your snippet, add it to the local library with: [18:45] bzr add your-snippet.py [18:45] obviously replace your-snippet.py with the filename for your snippet [18:45] now commit your changes: [18:45] bzr commit [18:46] when you run the above command you can enter a short message about what your snippet does [18:46] now you need to upload the snippet to Launchpad: [18:46] bzr push lp:~/python-snippets/ [18:46] so an example if I was to upload this I might use the following command: [18:46] bzr push lp:~jonobacon/python-snippets/new-gstreamer-snippet [18:47] finally, go to https://code.launchpad.net/python-snippets and you should see your branch listed there. Click on it and when the branch page information page loads click on the Propose for merging link. Add a short description of what you examples do in the Initial Comment box and then click the Propose Merge button. [18:48] QUESTION: is it possible to run acire and make it look in that directory for snippets instead of the default one? [18:48] right now, no, but I am adding a feature to do that [18:49] what you can do is set up a symbolic link from /usr/share/python-snippets to wherever you checked out the python-snippets code [18:49] QUESTION: Can we use Ground Control to submit a new snippet? [18:49] absolutely! [18:50] so what I recommend you folks do is check out the python-snippets library, add a snippet and submit it and I can test if it works in Acire [18:50] meanwhile I will get as feature into Acire to point it at another directory so it is easier to test it [18:51] so we have our snippets party at 9pm UTC, that is two hours away - I recommend you all come along to #ubuntu-app-devel and join us and I can help you get started writing snippets :) [18:51]