Guides¶
The guides are task-oriented. Each covers one part of pluxeo in depth, with examples that run as written.
Writing plugins¶
- Plugin Classes and Functions: the
Pluginclass, the@plugindecorator,should_load(),load()and its arguments. - Distributing a Plugin: entry points, and what makes a plugin cheap to discover.
- Cleanup and Dependencies: releasing resources on unload; loading another plugin first.
Building a host¶
- Selecting a Backend: asking for one plugin by name and using what it returns.
- Hooks: extension points every plugin can answer; result modes, wrappers, ordering.
- Async Hooks: calling hooks from an event loop.
- Enabling and Disabling: configuration, policies and runtime toggles.
- Contracts: checking the shape of every plugin in a namespace.
- Errors and Lifecycle Events: what happens when a plugin fails, and how to see it.
- Discovery Modes: entry points, a build-time index, package scanning, and direct registration.
Both sides¶
- Testing: testing a plugin, and testing a host with fake plugins.
- Cheat Sheet: one table, every task.