Document integrations and plugins

[SemTiOne]

Description

Adds docs/integrations.md — a guide covering how to extend Osprey via plugins, walking through UDFs (including side-effect UDFs and async UDFs), hash-based lookups, custom input sinks, output sinks (sync and async), connecting a labels service to a review tool, and plugging in ML models. Also registers the page in docs/SUMMARY.md.

Closes #383

• docs/integrations.md — new file
• docs/SUMMARY.md — add Integrations and Plugins under Concepts & More

Checklist

• Tests pass locally
• uv run ruff check . passes (no unused imports or other lint errors)
• uv tool run fawltydeps --check-unused --pyenv .venv passes (no unused dependencies)
• Updated CHANGELOG.md with my changes, if notable (refer to Keep a Changelog conventions)

Summary by CodeRabbit

• Documentation
  • Added a new “Integrations & Plugins” guide covering how to extend the system with plugin packages and UDFs, including sync/async worker hook discovery and invocation.
  • Documented UDF requirements (including examples and async guidance) and listed built-in hash lookup UDFs (MD5/SHA1/SHA256/SHA512).
  • Explained how to integrate custom input/output sinks via plugin-based registration, including a PostgreSQL labels-service example.
  • Updated the documentation index to link to the new page.

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR adds docs/integrations.md, documenting Osprey’s plugin architecture, UDFs, input/output sinks, labels services, ML model integration, and plugin packaging. docs/SUMMARY.md links to the new page.

Changes

Integrations Documentation

Layer / File(s)	Summary
Intro and plugin loading mechanism docs/integrations.md, docs/SUMMARY.md	Introduces the extension model, explains pluggy-based discovery via sync/async entry points, and adds a navigation link.
UDF authoring and registration docs/integrations.md	Covers UDF class structure, an example detection UDF, effects, async UDFs, registration via register_udfs, and built-in hash UDFs.
Input and output sink integration docs/integrations.md	Documents built-in and custom input streams and sync/async output sinks with their registration hooks.
Labels service and ML model integration docs/integrations.md	Documents a PostgreSQL-backed labels service and wrapping ML model predictions as UDFs.
Plugin packaging and reference docs/integrations.md	Documents pyproject.toml entry-point packaging and links to rules.md.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: ayubun, exbreder, haileyok

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	The new docs cover UDFs, sinks, hash lookups, ML models, and review-tool integration requested in #383.
Out of Scope Changes check	✅ Passed	The only code changes are the new docs page and its summary link, both aligned with the stated documentation scope.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly matches the main change: adding documentation for integrations and plugins.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[cassidyjames]

Thanks so much @SemTiOne!