1
FalkonTutorials/python/articles/1. Introduction.md
Juraj Oravec 31616ed388
Change KDE Falkon Phabricator link to Gitlab
Signed-off-by: Juraj Oravec <jurajoravec@mailo.com>
2022-03-18 22:16:48 +01:00

1.7 KiB

Falkon Python Tutorial - 1. Introduction

Hello, in this series I would like to introduce and describe how to write extensions for Falkon web browser with python.

Starting with Falkon 3.2 there is support for installing extensions from store which can be found at store.falkon.org

Falkon supports extensions written in C++, Python and Qml.
This series will go over the Python implementation.

Requirements

  1. Knowledge of C++
    Sadly, Falkon lacks documentation at this point in time, so only way to get some information is to browse through the source code.
    In this series there will be provided links to Falkon mirror on GitHub to compensate for documentation.
  2. The Falkon source code
  3. Knowledge of Python3, PySide2 and Qt
    It is good to have Qt documentation and Qt development tools like Qt Designer at hand.

Falkon module

To access Falkon specific features and functions inside the python script you need to use Falkon module.

import Falkon

The following part can be considered as cheat sheet. This section will be enhanced over the time.

Getting Main Application instance

In C++ known as mApp macro. In python we have to go the long way.

Falkon.MainApplication.instance()

Getting static settings data

In C++ known as qzSettings macro In python we have to go the long way.

Falkon.Settings.staticSettings()