Conversation
…ract Replaces the brief "Plugin System" section with a full "Plugin Architecture" chapter covering the two foundational principles: 1. Data Sovereignty — each SourcePlugin is the sole authority over its own data and has no knowledge of other sources or how its output is joined. All cross-source logic lives exclusively in DataBroker. 2. Download-then-Display — collection (CLI script, credentials, HTTP) and display (SourcePlugin.load(), zero network I/O) are strictly separated. load() raises FileNotFoundError if the local file is absent rather than falling back to a live fetch. Also updates the "Adding a plugin" walkthrough to show the download script step first, corrects config field types (file_path/dir_path replacing path), documents the ICON attribute, and notes that paths persist to data/config.json. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
11 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Replaces the brief "Plugin System" section in the README with a full Plugin Architecture chapter that establishes the two foundational design principles for all current and future source plugins.
Principle 1 — Data Sovereignty
Each
SourcePluginis the sole authority over its own data. It has no knowledge of other sources, their schemas, or how its output will be joined or merged. All cross-source logic (temporal joins, geographic enrichment, correlation) lives exclusively inDataBroker. This contract is illustrated with an ASCII diagram showing plugins as isolated islands feeding into a single broker.Principle 2 — Download-then-Display
Collection and display are strictly separated phases that must never be mixed:
data/.SourcePlugin.load()): reads only from the previously downloaded local file. Zero network calls, zero credentials required at runtime. RaisesFileNotFoundErrorif the file is absent — no live-fetch fallback.Other updates
file_path/dir_pathreplacing the oldpath)ICONattribute documenteddata/config.jsonacross restartsTest plan
🤖 Generated with Claude Code