kolibri-installer-gnome

Kolibri desktop front-end for GNOME.

Requirements

• Python 3.6+

Getting started

The fastest way to try the Kolibri GNOME front-end is to install the
Flatpak app from Flathub:

Building

To build and install this project, you will need to use the
Meson build system:

meson . build
ninja -C build
ninja -C build install

The resulting software expects to have Kolibri installed on the system, with
the Kolibri launcher in $PATH and Kolibri Python packages available in
$PYTHONHOME. We expect that an installer package will provide these
dependencies in addition to installing the desktop front-end.

It will also take advantage of having the following Kolibri plugins installed:

• kolibri-app-desktop-xdg-plugin
• kolibri-desktop-auth-plugin

If so, they will be automatically registered before Kolibri is
initialized.

Developer documentation

Setup repository

Please setup pre-commit as a git hook before submitting a pull
request:

# If you don't have pre-commit already:
pip install pre-commit

# Setup git hook:
pre-commit install

Now pre-commit will run automatically on git commit!

Using GNOME Builder

This project is ready to be built with Builder. Since this project has
multiple modules which interact through D-Bus, you will first have to
build and install a flatpak. Once the flatpak is installed, you'll be
able to develop any module.

1. Select Clone Repository from Builder's start dialog, or by
   opening the application menu at the right of the top bar. Fill in
   the Repository URL for this repository and click Clone Project.

2. Builder will attempt a build right after cloning. The next time you
   want to build, use the brick wall icon at the top bar.

3. Once the first build succeeds, click on the title in the middle of
   the top bar. It will open a panel. Click on the Export Bundle
   button. Once the export has successfully completed, Builder will
   open a file browser window showing the export directory, with the
   flatpak bundle already selected. Note that this file is named
   org.learningequality.Kolibri.Devel.flatpak, the ".Devel" allows
   parallel installation with the production flatpak.

4. Double-click the icon of the flatpak bundle file in order to
   install it. Or if you prefer a CLI output, copy the path to the
   file and use flatpak install from a Terminal window. The path is
   somewhere inside Builder's cache folder.

5. Now you are ready to develop. For running the front-end, just click
   on the play button at the top bar. For running any other module,
   you can change the command in the
   build-aux/flatpak/org.learningequality.Kolibri.Devel.json flatpak
   manifest file. Example: {"command": "/app/libexec/kolibri-app/kolibri-gnome-search-provider"}.

Modules

This repository includes the following modules:

• kolibri_gnome: A GNOME front-end for Kolibri
• kolibri_gnome_search_provider: A search provider for GNOME Shell
• kolibri_daemon: A system service to interact with Kolibri
• kolibri_gnome_launcher: A launcher for the frontend from desktop
  URIs
• kolibri_app: Common utilities used by the modules above
• libkolibri_daemon_dbus: Helper library for kolibri-daemon D-Bus
  interfaces

kolibri_gnome: Kolibri as a standalone GNOME app in a
webview. Opens channels as separate applications, each in their own
window (see kolibri_launcher). Has command line parameters to start
the webview in a specific channel or content page.

kolibri_gnome_search_provider: Expose Kolibri search capabilities
to GNOME Shell. The default search provider contains results for all
channels, but it is possible to group search results by their
respective channels by querying a channel-specific search provider
object. Interacts with the kolibri_daemon service to get search
results from kolibri.

kolibri_daemon: A D-Bus service to manage Kolibri lifecycle and
allow other modules to interact with the running Kolibri. It is possible to
run it as a system service, as opposed to a session service, using
configuration such as https://github.com/endlessm/eos-kolibri.
Exposes an App Key property that the frontend must use in order to
authenticate the webview.

kolibri_launcher: Launcher of kolibri-gnome. Understands desktop
URIs like kolibri-channel://, x-kolibri-dispatch:// and converts
them into kolibri-gnome arguments. Starts kolibri-gnome with a
specific application ID depending on the URI. This is why a launcher
process is needed instead of handling these URIs in kolibri-gnome.