The ubuntu-project template template contains the following commands.

  1. create
  2. dialog
  3. edit
  4. glade
  5. help
  6. license
  7. package
  8. release
  9. run
  10. save
  11. share

create

Usage: $quickly create ubuntu-project path/to/project_name

where "project_name" is one or more words separated by an underscore and path/to can be any existing path.

This will create and run a new project, including Python code, Glade files, and packaging files to make the project work. After creating the project, get started by:

    Changing your working directory to the new project: $cd path/to/project_name
  1. Edit the UI with Glade: $quickly glade
  2. Edit the Python code: $quickly edit

dialog

Usage: $quickly dialog dialog_name where dialog_name is one or more words seperated with underscore

This will create:

  1. A subclass of gtk.Dialog called DialogNameDialog in the module DialogNameDialog.py
  2. A glade file called DialogNameDialog.ui in the ui directory
  3. A catalog file called dialog_name_dialog.xml also in the ui directory

To edit the UI for the dialog, run: $quickly glade

To edit the behavior, run: $quickly edit

To use the dialog you have to invoke it from another python file:

  1. Import the dialog import DialogNameDialog
  2. Create an instance of the dialog dialog = DialogNameDialog.NewDialogNameDialog()
  3. Run the dialog and hide the dialog result = dialog.run() dialog.hide()

edit

Usage: $quickly edit

A convenience command to open all of your python files in your project directory in your default editor, ready for editing.

glade

Usage: $quickly glade

Opens Glade UI editor so that you can edit the UI for dialogs and windows in your project. Note that you *must* open Glade in this manner for quickly to work. If you try to open Glade directly, and the open the UI files, Glade will throw errors and won't open the files.

help

Usage: $quickly help

Opens a web browser with the help index.

license

Usage: $quickly license

Adds license to project files. Before using this command, you should:

  1. run $ quickly save in case something goes wrong
  2. Edit the file Copyright to include your authorship.
  3. If you want to put your own quickly unsupported Licence, remove and replace the tags ### BEGIN AUTOMATIC LICENCE GENERATION and ### END AUTOMATIC LICENCE GENERATION in it by your own licence.
  4. Executes either $ quickly license or $ quickly licence where can be either: - GPL-3 (default) - GPL-2

This will modify the Copyright file with the chosen licence (with GPL-3 by default). Updating previous chosen Licence if needed. If you previously removed the tags to add your own licence, it will leave it pristine. If no name is attributed to the Copyright, it will try to retrieve it from Launchpad (in quickly release or quickly share command only)

Finally, this will copy the Copyright at the head of every files.

Note that if you don't run quickly licence before calling quickly release or quickly share, this one will execute it for you and guess the copyright holder from your launchpad account if you didn't update it.

package

Usage: $quickly package

Creates a debian file (deb) from your project. Before running the package command you can edit the Icon and Category entry of *.desktop.in file, where * is the name of your project.

Note that if you didn't run quickly release, quickly share or quickly change-lp-project you may miss the name, email in setup.py. You can edit them if you don't want to use any of these commands afterwards. Those changes are not a mandatory at all for testing purpose.

release

Usage: $quickly release

Posts a release of your project to a PPA on launchpad so that users can install the application on their system.

You can also execute: $quickly release of you don't want to use current release_number. The release_number must be a number.

$quickly release notes about changes where "notes about changes" is optional text describing what changes were made since the last save

Before running quickly release, you should: create your account and a project page on http://launchpad.net. You also have to add a PPA to your launchpad account.

Name, email and version setup.py will be automatically changed. (version will be and bzr will commit and tagged. Once the release is done, will be incremented by 0.1 to be ready for next release.

If you previously used quickly shared ~publicX will be dropped to release version (~publicX < ) You can modify the description and long description if you wish.

You can run $quickly package and test your package to make sure it installs as expected. (This is not mandatory)

run

Usage: $quickly run

Runs your application. This is the best way to try test it out while you are developing it. It starts up the main project window.

save

Usage: $quickly save notes about changes
where "notes about changes" is optional text describing what changes were made since the last save.

This command commits all changes since the last save to bzr. Note that it does not push changes to any back up location. If you need revert or otherwise use the revision control, us bzr directly: $bzr help

share

Usage: $quickly share

Updates your PPA with the the latest saved project changes.

Before running quickly release, you should: create your account on http://launchpad.net. You also have to add a PPA to your launchpad account.

Name, email and version setup.py will be automatically changed. (version will be where X will be incremented at each quickly share execution) You can modify the description and long description if you wish.