13. Extending Keypirinha (API)

Keypirinha offers a flexible way to be extended thanks to its embedded Python3 interpreter and its exposed Python API through Python modules: keypirinha, keypirinha_util and keypirinha_net.

A Software Development Kit (SDK) is available that comes with a small battery of tools to help you through the process of creating your own plugin. You can grab it from here: SDK Repository

Before reading further, you may want to get familiar with the Packages Structure section to picture how Keypirinha loads and interprets its packages and their plugins, as well as the subtleties between the different types of packages.

• 13.1. Overview
  • 13.1.1. Threading
  • 13.1.2. Plugin Lifecycle
  • 13.1.3. Getting started
• 13.2. API Reference
  • 13.2.1. keypirinha module
  • 13.2.2. keypirinha_util module
  • 13.2.3. keypirinha_net module
  • 13.2.4. CatalogAction class
  • 13.2.5. CatalogItem class
  • 13.2.6. IconHandle class
  • 13.2.7. Plugin class
  • 13.2.8. Settings class
• 13.3. Embedded Python Interpreter
  • 13.3.1. Version
  • 13.3.2. Non-Debug
  • 13.3.3. Modifications