added the example external plugin

Author: alexandraBara

docs/node-scraper-external

@@ -0,0 +1,56 @@
+# node-scraper external plugins (example)
+
+This directory lives at **`/docs/node-scraper-external`** in the `node-scraper` repo and contains
+an example external plugin package you can install in editable mode.
+
+## Installation
+
+Use the same Python environment as `node-scraper`.
+
+**Option A — from the repo root:**
+```bash
+cd ~/node-scraper
+pip install -e ./docs/node-scraper-external
+```
+You should see `ext-nodescraper-plugins` installed in editable mode.
+
+
+## Verify the external package is importable
+
+```bash
+python - <<'PY'
+import ext_nodescraper_plugins
+print("ext_nodescraper_plugins loaded from:", ext_nodescraper_plugins.__file__)
+PY
+```
+
+## Run external plugins
+
+Confirm the CLI sees your external plugin(s):
+
+```bash
+node-scraper run-plugins -h
+node-scraper run-plugins SamplePlugin
+```
+
+## Add your own plugins
+
+Add new modules under the **`ext_nodescraper_plugins/`** package. Example layout:
+
+```
+/docs/node-scraper-external
+├─ pyproject.toml
+└─ ext_nodescraper_plugins/
+   ├─ __init__.py
+   └─ sample/
+      ├─ __init__.py
+      └─ sample_plugin.py
+```
+
+```
+
+Re-install (editable mode picks up code changes automatically, but if you add new files you may
+need to re-run):
+```bash
+pip install -e .
+```

docs/node-scraper-external/README.md

@@ -0,0 +1,25 @@
+from nodescraper.enums import EventCategory, EventPriority, ExecutionStatus
+from nodescraper.interfaces import DataAnalyzer
+from nodescraper.models import TaskResult
+
+from .sample_data import SampleDataModel
+
+
+class SampleAnalyzer(DataAnalyzer[SampleDataModel, None]):
+
+    DATA_MODEL = SampleDataModel
+
+    def analyze_data(self, data: SampleDataModel, args=None) -> TaskResult:
+        if data.some_str != "expected_str":
+            self.result.message = "String does not match expected"
+            self.result.status = ExecutionStatus.ERROR
+            return self.result
+
+            self._log_event(
+                category=EventCategory.OS,
+                description=f"{self.result.message}",
+                data={"expected": "expected_str", "actual": data.some_str},
+                priority=EventPriority.CRITICAL,
+                console_log=True,
+            )
+        return self.result

docs/node-scraper-external/ext_nodescraper_plugins/sample/__init__.py

@@ -0,0 +1,17 @@
+from nodescraper.base import InBandDataCollector
+from nodescraper.enums import ExecutionStatus
+from nodescraper.models import TaskResult
+
+from .sample_data import SampleDataModel
+
+
+class SampleCollector(InBandDataCollector[SampleDataModel, None]):
+
+    DATA_MODEL = SampleDataModel
+
+    def collect_data(self, args=None) -> tuple[TaskResult, SampleDataModel | None]:
+        sample_data = SampleDataModel(some_str="example123")
+        self.result.message = "Collector ran successfully"
+        self.result.status = ExecutionStatus.OK
+
+        return self.result, sample_data

docs/node-scraper-external/ext_nodescraper_plugins/sample/sample_analyzer.py

@@ -0,0 +1,5 @@
+from nodescraper.models import DataModel
+
+
+class SampleDataModel(DataModel):
+    some_str: str

docs/node-scraper-external/ext_nodescraper_plugins/sample/sample_collector.py

@@ -0,0 +1,15 @@
+from nodescraper.base import InBandDataPlugin
+
+from .sample_analyzer import SampleAnalyzer
+from .sample_collector import SampleCollector
+from .sample_data import SampleDataModel
+
+
+class SamplePlugin(InBandDataPlugin[SampleDataModel, None, None]):
+    """Example external plugin."""
+
+    DATA_MODEL = SampleDataModel
+
+    COLLECTOR = SampleCollector
+
+    ANALYZER = SampleAnalyzer

docs/node-scraper-external/ext_nodescraper_plugins/sample/sample_data.py

@@ -0,0 +1,9 @@
+[project]
+name = "ext-nodescraper-plugins"
+version = "0.1.0"
+requires-python = ">=3.10"
+dependencies = ["node-scraper"]
+
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"