Documentationsection 12 of 13
Plugins
- 1Plugins: your own tools, without touching the repository
A plugin is a Python module that gives Kotoba a tool she did not ship with. You write it on your own machine, in your own directory or your own package. You…
- 2Your first plugin
One file, one tool, no packaging. At the end of this page she can fetch the front page of Hacker News, announce it in her own voice, and show it in the work…
- 3The tool module contract
Everything the loader and the agent loop read off your module, enumerated from the code. Two attributes are required. The rest have defaults, and this page…
- 4Installing a plugin, and shipping one
Two paths. This page covers both from the installing person's side and from the author's side, and ends with what survives an upgrade.
- 5How the loader works
What makes a plugin valid, what makes it rejected, what happens when one is broken, and what happens when two of them want the same name. All of it read off…
- 6The security position, stated plainly
A plugin is somebody else's Python running inside her process, as your user account. It is not sandboxed from your machine, and nothing inspects it before it…
- 7Testing your plugin
Your plugin lives outside the repository, so it needs its own tests. The good news is that most of it tests like ordinary Python: execute() is a coroutine you…