This is Keypirinha launcher's official Software Development Kit (SDK).
- Create an add-on skeleton to start developing your plugin
- Build a redistributable package that is ready-to-use by Keypirinha users
- Test some features with the bundled standalone Python3 interpreter, which is a replicate of Keypirinha's embedded one
The recommended way is to clone the official git repository as the
branch is meant to be stable:
git clone https://github.com/Keypirinha/SDK.git keypirinha-sdk
Otherwise, GitHub conveniently allows to download an archive of the current revision.
No particular configuration is required to use the SDK.
For convenience, high-level features of the SDK are accessible via the
directory, which you can safely add to your
PATH since it has been made
specifically to be as non-intrusive as possible.
Once you have opened a console, you may want to setup SDK's environment by
Particularly, it defines
KEYPIRINHA_SDK, that is the path to the directory of
It also prepends the
cmd directory to the
PATH of the current console
Create a Package
This SDK allows to create the skeleton (i.e. the file and code structure) of your package by running a single command.
kptmpl package <MyPackName> [dest_dir]
Note that the file structure created is not suitable to be copied as-is under
Packages directory and is meant to be more flexible for the
developer, not the user. May you wish to redistribute your package, the
recommended way is to build it first.
Where to start
Also, the exposed part of Keypirinha's Python API, on which packages rely on, has its own repository.
Build a Package
To build a package means all the files required for Keypirinha to load your
plugin(s) will be encapsulated in a single zip archive that has got the
*.keypirinha-package extension so users of your package can easily download
and install it under the
profile/InstalledPackage directory. This is the
recommended form of redistribution.
Once you have developed and tested your package, you can build its final
redistributable archive (i.e.
*.keypirinha-package) by using the
script located in your package directory.
Note that SDK's environment must be setup by running the
Then, from your package's directory:
The bootstrap script
cmd/kpy allows to execute any Python3 script using the
bundled and standalone interpreter, which is a replicate of the one that is
embedded into Keypirinha.
You can also start the interpreter in interactive mode, as you would do with
python.exe executable of the standard Python distribution (i.e. with no
The SDK is distributed under the terms of the
zlib license unless stated
otherwise in files from third-party projects. See the
LICENSE file located in
this directory for more information.
- Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
- Fork the repository on GitHub to start making your changes.
- Send a pull request. Please stick to one feature per PR.