Click is the code name used to describe a packaging format for Ubuntu mobile applications. This format specifies how individual apps are delivered to mobile devices, how they are packed into distributable format, and how they are installed on a mobile device by a system provided package manager. At a minimum they assume that a system framework exists providing all the necessary infrastructure and dependencies needed in order to install and run such apps.
The click packaging format is completely independent from facilities to do full-system installations or upgrades.
Currently, this package should remain compatible with Python 2.7, 3.2, 3.3, and 3.4; Ubuntu 12.04 LTS, Ubuntu 13.10, and Ubuntu 14.04 LTS.
If you run from a fresh bzr checkout, please ensure you have the required build dependencies first by running:
and installing anything that is missing here.
$ ./configure --prefix=/usr \
to build the project.
For Ubuntu 14.04, make sure you have the python2.7 and python3.4
packages installed. Unless you upgraded from a previous version of Ubuntu
and haven’t removed it yet, you won’t have Python 3.3 and Python 3.2
available. Build them from source if necessary, install them say into
/usr/local, and make sure they are on your
You’ll need tox (Ubuntu package python-tox) installed in order to run the full test suite. You should be able to just say:
to run the full suite. Use tox’s
-e option to run the tests against a
subset of Python versions. You shouldn’t have to install anything manually
into the virtual environments that tox creates, but you might have to if you
don’t have all the dependencies installed in your system Pythons.
You’ll need the mock and python-debian libraries. For Ubuntu 13.10, apt-get install the following packages:
After all of the above is installed, you can run
tox to run the test suite
against all supported Python versions. The
./run-tests scripts just does
an additional check to make sure you’ve got the preload shared library
To run a specific testcase, use the standard python unittest syntax like:
$ python3 -m unittest click.tests.test_install
$ python2 -m unittest click.tests.test_build.TestClickBuilder.test_build
If you have python-coverage installed, you can get a Python test coverage report by typing:
$ python-coverage combine $ python-coverage report
This works also for python3-coverage.
To get Vala/C coverage information, install the gcovr and lcov packages and run:
$ ./configure –enable-gcov $ make coverage-html
which will generate a “coveragereport/index.html” file for you.
The combined coverage information can be obtained via:
$ make coverage.xml
There is also a set of integration tests that have additional test dependencies that are listed in debian/test/control.
Beware that some require to be run as root and they are designed to be run in a safe environment (like a schroot or a autopkgtest container) and may alter the system state (e.g adding test users). By default the tests will run against the installed click binary, but you can also use:
- $ LD_LIBRARY_PATH=$(pwd)/lib/click/.libs
- PYTHONPATH=$(pwd) GI_TYPELIB_PATH=$(pwd)/lib/click CLICK_BINARY=$(pwd)/bin/click TEST_INTEGRATION=1 python3 -m unittest discover click.tests.integration
to run against the build tree.
To build the HTML version of the documentation, you’ll need Sphinx (Ubuntu package python-sphinx). Then do:
$ (cd doc && make html)