homesec 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

homesec/__init__.py

@@ -1,6 +1,6 @@
 """HomeSec camera pipeline."""
 
-__version__ = "0.1.0"
+__version__ = "0.1.1"
 
 # Export commonly used types
 from homesec.errors import PipelineError

{homesec-0.1.0.dist-info → homesec-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: homesec
-Version: 0.1.0
+Version: 0.1.1
 Summary: Pluggable async home security camera pipeline with detection, VLM analysis, and alerts.
 Project-URL: Homepage, https://github.com/lan17/homesec
 Project-URL: Source, https://github.com/lan17/homesec
@@ -261,6 +261,7 @@ best-effort, and non-critical stages can fail without losing the alert.
 - Policy-driven alerts with per-camera overrides
 - Fan-out notifiers (MQTT for Home Assistant, SendGrid email)
 - Postgres-backed state + events with graceful degradation
+- Built around small, stable interfaces so new plugins drop in cleanly
 - Health endpoint plus optional Postgres telemetry logging
 
 ## Pipeline at a glance
@@ -377,6 +378,27 @@ storage:
 - For a quick local run, pair `local_folder` with `local` storage and drop a clip
   into `recordings/`.
 
+## Extensible by design
+
+HomeSec is intentionally modular. Each major capability is an interface
+(`ClipSource`, `StorageBackend`, `ObjectFilter`, `VLMAnalyzer`, `AlertPolicy`,
+`Notifier`) defined in `src/homesec/interfaces.py`, and plugins are discovered at
+runtime via entry points. This keeps the core pipeline small while making it
+easy to add new backends without editing core code.
+
+What this means in practice:
+- Swap storage or notifications by changing config, not code.
+- Add a new plugin type as a separate package and register it.
+- Keep config validation strict by pairing each plugin with a Pydantic model.
+
+Extension points (all pluggable):
+- Sources: RTSP motion detection, FTP uploads, local folders
+- Storage backends: Dropbox, local disk, or your own
+- Filters: object detection (YOLO or custom models)
+- VLM analyzers: OpenAI-compatible APIs or local models
+- Alert policies: per-camera rules and thresholds
+- Notifiers: MQTT, email, or anything else you can send from Python
+
 ## CLI
 
 - Run the pipeline:
@@ -399,6 +421,11 @@ storage:
 HomeSec discovers plugins via entry points in the `homesec.plugins` group. A plugin
 module just needs to import and register itself.
 
+Each plugin provides:
+- A unique name (used in config)
+- A Pydantic config model for validation
+- A factory that builds the concrete implementation
+
 ```python
 # my_package/filters/custom.py
 from pydantic import BaseModel

{homesec-0.1.0.dist-info → homesec-0.1.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-homesec/__init__.py,sha256=V-CRoux1Qo5d8Logyv0k0VDtVyLdExE8vSU1dpMtVBU,452
+homesec/__init__.py,sha256=tO_V5DJgS44qHCIySDUFIK5-Rbgjh3MpUBHa2HhZiB4,452
 homesec/app.py,sha256=I1N5V22_ERREFXt4lcmKtUkwby6agKcO8gewHHN04iQ,14327
 homesec/cli.py,sha256=4cOlJvdpz5iPuLtydSWNpWGvH978axk77AE3EvW7CYc,5637
 homesec/errors.py,sha256=RfdPTP8uMfdO3GQPtgakOIKSSelM2CIhGO7tkgNEPps,2123
@@ -55,8 +55,8 @@ homesec/telemetry/db_log_handler.py,sha256=7qjKB9q6YWuy8ySoNWcPA4ENmDcvq8yYV2ooE
 homesec/telemetry/postgres_settings.py,sha256=EVD2_oi_KReFJvQmXxW026aurl_YD-KexT7rkbGQPHc,1198
 homesec/telemetry/db/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 homesec/telemetry/db/log_table.py,sha256=wcZLwRht7FMa0z2gf37f_RxdVTNIdDiK4i_N3c_ibwg,473
-homesec-0.1.0.dist-info/METADATA,sha256=fQu17bHr7Yw3tVupfPYSAbnJvNDSTzvVEgmMXdrNvjk,20374
-homesec-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-homesec-0.1.0.dist-info/entry_points.txt,sha256=8ocCj_fP1qxIuL-DVDAUiaUbEdTMX_kg_BzVrJsbQYg,45
-homesec-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-homesec-0.1.0.dist-info/RECORD,,
+homesec-0.1.1.dist-info/METADATA,sha256=rP26T3y8E6t8d4dm1tqWq1BZrleLMM12YtpF7nUaAUM,21590
+homesec-0.1.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+homesec-0.1.1.dist-info/entry_points.txt,sha256=8ocCj_fP1qxIuL-DVDAUiaUbEdTMX_kg_BzVrJsbQYg,45
+homesec-0.1.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+homesec-0.1.1.dist-info/RECORD,,