apx-example

Template for an Action Platform plugin — an apx, Action Platform extension; every package is named apx-<slug>. Every extension point once, small enough to read in one sitting:

Use this template

1. Create a repository from it, named apx-<slug>.
2. Rename apx_example → apx_<slug>, example → <slug> in pyproject.toml (package name, entry points), plugin.py (slug), target.py (name), cli.py, overlays/index.json.
3. Delete what you do not need; a plugin with only plugin.py and one tool is fine.
4. pip install -e ".[dev]", pytest, action-platform plugin list (shows example once installed).
5. Publish to PyPI; open a pull request to plugins-index with <slug>.json.

Rules

• register only declares; no I/O, threads or connections at import or in register.
• No monkey-patching of action_platform.* — replace a slot (surface.core.replace) or ask for a hook.
• needs lists every host you talk to and every environment variable you read.

Reference: writing a plugin · plugins.