1
.. Click Packages documentation master file, created by
2
sphinx-quickstart on Mon Apr 15 11:34:57 2013.
3
You can adapt this file completely to your liking, but it should at least
4
contain the root `toctree` directive.
10
*Click* is the code name used to describe a packaging format for Ubuntu mobile
11
applications. This format specifies how individual apps are delivered to
12
mobile devices, how they are packed into distributable format, and how they
13
are installed on a mobile device by a system provided package manager. At a
14
minimum they assume that a system framework exists providing all the
15
necessary infrastructure and dependencies needed in order to install and run
18
The click packaging format is completely independent from facilities to do
19
full-system installations or upgrades.
25
Currently, this package should remain compatible with Python 2.7 and 3.3.
31
For Ubuntu 13.04, make sure you have the *python2.7* and *python3.3* packages
34
You'll need *gcc* in order to build the preload shared library. Assuming you
35
have this, do the following::
37
$ (cd preload && make)
39
You'll need *tox* (Ubuntu package *python-tox*) installed in order to run the
40
full test suite. You should be able to just say::
44
to run the full suite. Use tox's ``-e`` option to run the tests against a
45
subset of Python versions. You shouldn't have to install anything manually
46
into the virtual environments that tox creates, but you might have to if you
47
don't have all the dependencies installed in your system Pythons.
49
You'll need the *mock* and *python-debian* libraries. For Ubuntu 13.04,
50
apt-get install the following packages::
60
After all of the above is installed, you can run ``tox`` to run the test suite
61
against all supported Python versions. The ``./run-tests`` scripts just does
62
an additional check to make sure you've got the preload shared library
69
To build the HTML version of the documentation, you'll need Sphinx (Ubuntu
70
package *python-sphinx*). Then do::
72
$ (cd doc && make html)