kollabor-plugins

kollabor-plugins is the plugin framework for Kollabor.

It provides plugin discovery, safe instantiation, lifecycle management, status collection, the base plugin class, and SDK helpers. Concrete plugins live in the repo-level plugins/ directory or installed package plugin locations.

Current Role

Discover plugin classes from development and installed plugin directories.
Instantiate plugins with shared dependencies such as event bus, config, and services.
Provide a stable BasePlugin lifecycle for initialization, hook registration, status, config widgets, and shutdown.
Collect plugin startup/status information without crashing the host app.
Provide utility helpers for safe optional-method calls.

Architecture

Module	Responsibility
`base.py`	`BasePlugin` lifecycle and default methods
`discovery.py`	plugin class discovery
`factory.py`	dependency-aware plugin construction
`registry.py`	plugin registration and lifecycle registry
`collector.py`	status/startup info collection
`plugin_sdk.py`	helper API for plugin authors
`plugin_utils.py`	safe calls, metadata, interface validation

Plugin Shape

from kollabor_plugins import BasePlugin


class MyPlugin(BasePlugin):
    name = "my_plugin"
    version = "1.0.0"
    description = "Adds one useful thing"

    async def initialize(self, args=None, **kwargs):
        return None

    async def register_hooks(self):
        return None

    async def shutdown(self):
        return None

Discovery order:

./plugins/
Installed package plugin locations.

Lifecycle:

Discover plugin classes.
Instantiate with dependencies.
Call initialize().
Call register_hooks().
Call shutdown() on app exit.

Known Gaps

Plugin metadata and config schemas are partly convention-based; stronger typed metadata would help UI and docs generation.
Discovery order and dependency injection behavior should be covered by more integration tests across local and installed plugin layouts.
Plugin shutdown must remain best-effort and non-blocking; long-running plugin tasks need clearer ownership and cancellation guidance.

Roadmap

Phase 1: Authoring clarity

Add a plugin author guide generated from real BasePlugin methods.
Document config widget and status-line conventions.
Add examples for hook-only, command, fullscreen, and background-task plugins.

Phase 2: Lifecycle hardening

Add tests for plugin discovery, instantiation failures, and shutdown failures.
Track plugin-owned tasks/resources explicitly.
Make startup/status collection easier to inspect from CLI and engine surfaces.

Phase 3: Packaging and marketplace readiness

Normalize plugin metadata fields for installed packages.
Document compatibility/version expectations for plugins.
Prepare a stable manifest format if plugins move toward external distribution.

Development

Targeted validation examples:

python -m py_compile packages/kollabor-plugins/src/kollabor_plugins/*.py
python -m pytest tests/unit/commands/test_all_command_handlers.py -q

Dependencies

kollabor-events

License

MIT

Metadata

Release files for kollabor-plugins 0.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kollabor-plugins 0.8.1
File	Size	Uploaded
kollabor_plugins-0.8.1.tar.gz	18.6 kB	Sep 19, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for kollabor-plugins 0.8.1
File	Interpreter	ABI	Platform	Reset
kollabor_plugins-0.8.1-py3-none-any.whl 21.4 kB Sep 19, 2026	Python 3	none	any	Details

Total release size: 40.0 kB

Release files / kollabor_plugins-0.8.1.tar.gz

Download URL	kollabor_plugins-0.8.1.tar.gz
Size	18.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`6ced0f8326fb1aa0088ce87f59b0c6b4c7926ac51aa06cb7fe7641a52b6a784e`
BLAKE2b-256 checksum How to use checksums	`423ee592448aba385847c943e97339ff1975c8174c59b7b052497ae74f17e1e5`
Upload date	Sep 19, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / kollabor_plugins-0.8.1-py3-none-any.whl

Download URL	kollabor_plugins-0.8.1-py3-none-any.whl
Size	21.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`777c291d9815dfc0a9384213b5665b71c57efd5d64dba87f4773a771a23660fd`
BLAKE2b-256 checksum How to use checksums	`ccbe6b05fbec066cdd222156f4e33802e348010f0aafc2eba3e0c2efbec4def6`
Upload date	Sep 19, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`