Maemo Wiki Mirror - User contributions [en]

PyMaemo/Scratchboxless packaging guide

2010-06-16T23:15:22Z

201.75.7.138: /* Uploading to extras */

== Introduction ==

The usual way of developing Maemo applications is using or Scratchbox or [[MADDE]], which are quite heavy for Python development. An alternative is using [http://github.com/astraw/stdeb stdeb], a set of extensions to distutils that allows generating debian packages, both binary and source, that can be installed on the device or sent to the [[extras-devel]] repository.

This tutorial will show how to integrate it into your project, building the packages and uploading it to extras-devel.

== Prerequisites ==

This tutorial is aimed at Debian-based systems, as some stdeb commands requires the dpkg tools installed.

Also, you should get the [http://github.com/astraw/stdeb git] version of stdeb to use the debianize command, as it is a new addition and not yet available in the repositories. Run the following commands to install it:

# Clone the git repository
git clone http://github.com/astraw/stdeb.git

# Enter source package
cd stdeb

# Build .deb (making use of stdeb package directory in sys.path).
python setup.py --command-packages=stdeb.command bdist_deb

# Install it
sudo dpkg -i deb_dist/python-stdeb_0.5.1+git-1_all.deb

As only python2.5 is supported in pymaemo, it should be installed if you want to create binary packages. On Ubuntu Lucid (10.04), you can install it from [https://launchpad.net/~fkrull/+archive/deadsnakes this ppa], following the instructions [http://www.codigomanso.com/en/2010/05/google-app-engine-en--10-4-lucid-lynx/ here].

== Preparing the package ==

As stdeb extends distutils, it is necessary that you have a working setup.py script. For our example application, which consists of a [http://pymaemo.garage.maemo.org/stdeb_example/myscript-app/myscript single script] named "myscript" and support files like [http://pymaemo.garage.maemo.org/stdeb_example/myscript-app/myscript.desktop .desktop]<ref name="desktop">[[Desktop file format]]</ref> and an [http://pymaemo.garage.maemo.org/stdeb_example/myscript-app/myscript.png icon]<ref name="icon">[[Packaging#Displaying an icon in the Application Manager next to your package]]</ref>, the [http://pymaemo.garage.maemo.org/stdeb_example/myscript-app/setup.py setup.py] will look like this:
<source lang="python">
from distutils.core import setup

setup(
name='myscript',
version='0.1',
author='Lauro Moura',
author_email='lauro.neto@donotspamme.com',
scripts=['myscript'],
data_files=[('share/applications/hildon', ['myscript.desktop']),
('share/pixmaps', ['myscript.png'])],
)
</source>
A file named [http://pymaemo.garage.maemo.org/stdeb_example/myscript-app/stdeb.cfg stdeb.cfg] in the same directory as setup.py is required, with stdeb Maemo-specific options. A detailed list of options can be found in the [http://github.com/astraw/stdeb stdeb website].

[DEFAULT]
XS-Python-Version: 2.5 # Only version currently supported by PyMaemo.
Package:myscript # Binary package name. stdeb adds the prefix "python-" by default
Section: user/development # Section should start with user/ to appear in the menu.
Depends: python-gtk2 # extra dependencies go here

Warning 1: Make sure to use [[Maemo_packaging#Sections|an allowed section]].

Warning 2: The <code>Depends</code> field in stdeb.cfg will be used on your debian/control file, so fill it correctly with all the dependencies of your application - otherwise it will break when you try to install it. For instance, [http://gitorious.org/twcano/twcano twcano] depends on the following packages: <code>python-simplejson, pyside-qt4-maemo5, pyside-qt4-webkit and python-twitter</code>, so the <code>Depends</code> field should be filled this way:

Depends: python-simplejson, pyside-qt4-maemo5, pyside-qt4-webkit, python-twitter

== Building the packages ==

The basic command is

python setup.py --command-packages=stdeb.command bdist_deb

It'll create a folder called deb_dist with the source and binary packages. Alternatively, the "sdist_dsc" command will create only the source package.

After generating, you can copy the package to your device and install it (requires an [[SSH]] server):

$ scp myscript_0.1-1_all.deb root@<n900 ip>:/root
$ ssh root@<n900 ip>
# dpkg -i myscript_0.1-1_all.deb

== Building a basic debian directory ==

Another useful command is ''debianize''. It will read the configuration file and write a directory named debian in the same directory. This can be used for manually creating the packages using dpkg tools directly. For a detailed usage example see the [http://github.com/astraw/stdeb#debianize-distutils-command steb website].

Note: sdist_dsc and bdist_deb do '''not''' use this directory, generating a new one in the source dir under deb_dist/.

== Uploading to extras ==

To upload to extras, use the debianize command and then call dpkg-buildpackage:

$ dpkg-buildpackage -rfakeroot -uc -us -S

This command will create the .dsc, .tar.gz and .changes files that can be used to [[uploading to Extras-devel|upload the application to extras-devel]].

== Future work ==

Support for non-Debian systems.

== References ==

<references />

[[Category:Python]]
[[Category:Packaging]]

PyMaemo/Scratchboxless packaging guide

2010-06-16T23:14:37Z

201.75.7.138: /* Preparing the package */

== Introduction ==

The usual way of developing Maemo applications is using or Scratchbox or [[MADDE]], which are quite heavy for Python development. An alternative is using [http://github.com/astraw/stdeb stdeb], a set of extensions to distutils that allows generating debian packages, both binary and source, that can be installed on the device or sent to the [[extras-devel]] repository.

This tutorial will show how to integrate it into your project, building the packages and uploading it to extras-devel.

== Prerequisites ==

This tutorial is aimed at Debian-based systems, as some stdeb commands requires the dpkg tools installed.

Also, you should get the [http://github.com/astraw/stdeb git] version of stdeb to use the debianize command, as it is a new addition and not yet available in the repositories. Run the following commands to install it:

# Clone the git repository
git clone http://github.com/astraw/stdeb.git

# Enter source package
cd stdeb

# Build .deb (making use of stdeb package directory in sys.path).
python setup.py --command-packages=stdeb.command bdist_deb

# Install it
sudo dpkg -i deb_dist/python-stdeb_0.5.1+git-1_all.deb

As only python2.5 is supported in pymaemo, it should be installed if you want to create binary packages. On Ubuntu Lucid (10.04), you can install it from [https://launchpad.net/~fkrull/+archive/deadsnakes this ppa], following the instructions [http://www.codigomanso.com/en/2010/05/google-app-engine-en--10-4-lucid-lynx/ here].

== Preparing the package ==

As stdeb extends distutils, it is necessary that you have a working setup.py script. For our example application, which consists of a [http://pymaemo.garage.maemo.org/stdeb_example/myscript-app/myscript single script] named "myscript" and support files like [http://pymaemo.garage.maemo.org/stdeb_example/myscript-app/myscript.desktop .desktop]<ref name="desktop">[[Desktop file format]]</ref> and an [http://pymaemo.garage.maemo.org/stdeb_example/myscript-app/myscript.png icon]<ref name="icon">[[Packaging#Displaying an icon in the Application Manager next to your package]]</ref>, the [http://pymaemo.garage.maemo.org/stdeb_example/myscript-app/setup.py setup.py] will look like this:
<source lang="python">
from distutils.core import setup

setup(
name='myscript',
version='0.1',
author='Lauro Moura',
author_email='lauro.neto@donotspamme.com',
scripts=['myscript'],
data_files=[('share/applications/hildon', ['myscript.desktop']),
('share/pixmaps', ['myscript.png'])],
)
</source>
A file named [http://pymaemo.garage.maemo.org/stdeb_example/myscript-app/stdeb.cfg stdeb.cfg] in the same directory as setup.py is required, with stdeb Maemo-specific options. A detailed list of options can be found in the [http://github.com/astraw/stdeb stdeb website].

[DEFAULT]
XS-Python-Version: 2.5 # Only version currently supported by PyMaemo.
Package:myscript # Binary package name. stdeb adds the prefix "python-" by default
Section: user/development # Section should start with user/ to appear in the menu.
Depends: python-gtk2 # extra dependencies go here

Warning 1: Make sure to use [[Maemo_packaging#Sections|an allowed section]].

Warning 2: The <code>Depends</code> field in stdeb.cfg will be used on your debian/control file, so fill it correctly with all the dependencies of your application - otherwise it will break when you try to install it. For instance, [http://gitorious.org/twcano/twcano twcano] depends on the following packages: <code>python-simplejson, pyside-qt4-maemo5, pyside-qt4-webkit and python-twitter</code>, so the <code>Depends</code> field should be filled this way:

Depends: python-simplejson, pyside-qt4-maemo5, pyside-qt4-webkit, python-twitter

== Building the packages ==

The basic command is

python setup.py --command-packages=stdeb.command bdist_deb

It'll create a folder called deb_dist with the source and binary packages. Alternatively, the "sdist_dsc" command will create only the source package.

After generating, you can copy the package to your device and install it (requires an [[SSH]] server):

$ scp myscript_0.1-1_all.deb root@<n900 ip>:/root
$ ssh root@<n900 ip>
# dpkg -i myscript_0.1-1_all.deb

== Building a basic debian directory ==

Another useful command is ''debianize''. It will read the configuration file and write a directory named debian in the same directory. This can be used for manually creating the packages using dpkg tools directly. For a detailed usage example see the [http://github.com/astraw/stdeb#debianize-distutils-command steb website].

Note: sdist_dsc and bdist_deb do '''not''' use this directory, generating a new one in the source dir under deb_dist/.

== Uploading to extras ==

To upload to extras, use the debianize command and then call dpkg-buildpackage:

$ dpkg-buildpackage -rfakeroot -uc -us -S

This command will create the .dsc, .tar.gz and .changes files that can be used to [[uploading to Extras-devel|upload the application to extras-devel]]

== Future work ==

Support for non-Debian systems.

== References ==

<references />

[[Category:Python]]
[[Category:Packaging]]