opennvr-app-sdk 0.4.0__tar.gz

opennvr_app_sdk-0.4.0/.gitignore

@@ -0,0 +1,276 @@
+# Root-level ignores
+
+# ============================================
+# SENSITIVE DATA - NEVER COMMIT
+# ============================================
+# Environment variables
+.env
+.env.*
+!.env.example
+
+# Cryptographic keys and certificates
+server/keys/*.pem
+server/keys/*.key
+server/keys/*.crt
+server/keys/*.cert
+server/keys/*.p12
+server/keys/*.pfx
+server/keys/*.jks
+!server/keys/.gitkeep
+byok-test-certs/
+
+# M1b-fixup H-3: locally-generated MediaMTX self-signed certs
+mediamtx-certs/
+
+# ISSUE-6: locally-generated nginx TLS-reverse-proxy self-signed cert.
+# Each operator's deployment mints its own keypair on first boot via
+# nginx-certs-init; never committed.
+nginx-certs/
+
+# Agent examples' self-signed TLS pairs (camera-agent[-lite]-certs-init).
+agent-certs/
+
+# ISSUE-6 v3: host-hardening artifacts. The nft template + snapshot
+# directories are operator-local — they reference the operator's
+# specific interface names and contain `nft list ruleset` snapshots
+# that may include details of their other firewall rules.
+#
+# ISSUE-9 fix: the pattern is anchored with a leading slash so it
+# matches ONLY ``./host-hardening/`` (the operator artifact dir
+# created by ``scripts/apply-camera-vlan-hardening.sh``), not
+# ``./tests/host-hardening/`` (our regression test suites — which
+# the un-anchored pattern accidentally excluded for the entire
+# life of the ISSUE-6 → ISSUE-8 series, leaving every "X tests
+# green" claim in CHANGELOG referencing files that lived only in
+# local working trees).
+/host-hardening/
+
+# Secrets and credentials
+secrets/
+*.secret
+*_secret.txt
+credentials.json
+token.json
+
+# ============================================
+# GENERATED BUILD ARTIFACTS
+# ============================================
+# Generated recordings output
+Recordings/
+recordings/
+!app/src/views/settings/recordings/
+*.mp4
+*.mkv
+*.avi
+*.webm
+# …except the bundled talking-avatar clips (placeholders; swap your own in)
+!examples/camera-agent/demo/avatar/*.mp4
+!examples/camera-agent/demo/avatar/*.webm
+
+# Python compiled
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.pyo
+*.pyd
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+!app/src/lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Python virtual environments
+venv/
+env/
+ENV/
+.venv/
+server/venv/
+
+# uv lockfiles (tracked in git for reproducibility)
+# Uncomment if you don't want to track lockfiles:
+# uv.lock
+
+# Frontend builds
+app/dist/
+app/dist-ssr/
+app/dev-dist/
+app/node_modules/
+app/.cache/
+
+# ============================================
+# LOGS AND DEBUG FILES
+# ============================================
+# Application logs
+logs/
+*.log
+*.log.*
+server/logs/*.log
+server/logs/*.log.*
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+# Debug files
+debug_*.py
+debug_*.txt
+*_debug.txt
+server/debug_*.py
+server/debug_*.txt
+
+# ============================================
+# TEMPORARY AND TEST FILES
+# ============================================
+# Ad-hoc scratch test scripts at the repo root or in server/ are ignored
+# (they're typically one-off diagnostics that shouldn't ship). Real test
+# suites under server/tests/ ARE tracked — the negation below re-includes
+# them so pytest discovery works in CI.
+test_*.py
+*_test.py
+server/test_*.py
+!server/tests/test_*.py
+!server/tests/**/test_*.py
+# KAI-C's pytest suite (A2.4): same negation pattern as server/tests/.
+!kai-c/test/test_*.py
+# Example-app pytest suites (A2.5+): each example/{slug}/tests/ is part
+# of the shipped artifact and must be tracked.
+!examples/**/tests/test_*.py
+# detect-pipeline (Tier-0) pytest suite: same negation pattern — the tests
+# live in detect-pipeline/test/ (singular) and MUST be tracked so CI runs them.
+!detect-pipeline/test/test_*.py
+# App SDK pytest suite: same negation pattern as server/tests/. Without
+# this the blanket ``test_*.py`` above silently untracked the whole
+# sdk/opennvr-app-sdk/tests/ suite.
+!sdk/opennvr-app-sdk/tests/test_*.py
+# App template smoke test: part of the shipped scaffold — the generator
+# copies it into every new app and FIRST_DETECTOR.md promises it passes
+# out of the box. Without this negation the blanket ``test_*.py`` above
+# silently untracked it (review finding: fresh clones got "no tests ran").
+!templates/opennvr-app/tests/test_*.py
+# App-installer pytest suite: same negation pattern.
+!scripts/app-installer/tests/test_*.py
+server/scripts/check_*.py
+server/scripts/get_*.py
+server/scripts/delete_*.py
+server/scripts/update_*.py
+server/scripts/debug_*.py
+server/scripts/setup_venv.py
+server/scripts/logging_summary.py
+server/scripts/inspect_schema.py
+server/check_*.py
+server/get_*.py
+server/delete_*.py
+server/update_*.py
+*.dat
+*.tmp
+*.temp
+*.cache
+
+# Database dumps and backups
+*.sql
+*.db
+*.sqlite
+*.sqlite3
+*.dump
+
+# ============================================
+# CONFIGURATION FILES (LOCAL OVERRIDES)
+# ============================================
+# MediaMTX configs (should use default from repo)
+server/mediamtx*.yml
+!mediamtx.yml
+
+# Local configs
+*.local
+*.local.*
+!mediamtx.local.yml
+config.local.*
+
+# ============================================
+# OS GENERATED FILES
+# ============================================
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+desktop.ini
+*~
+
+# ============================================
+# IDE AND EDITOR FILES
+# ============================================
+.vscode/
+.idea/
+*.swp
+*.swo
+*.swn
+*.bak
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+.metadata
+
+# ============================================
+# THIRD-PARTY EXECUTABLES
+# ============================================
+# MediaMTX binary
+mediamtx/
+mediamtx.exe
+mediamtx
+
+# ============================================
+# DOCUMENTATION (ANALYSIS/DESIGN DOCS)
+# ============================================
+# These are analysis docs, not part of codebase
+CURRENT_PLAYBACK_ARCHITECTURE.md
+KEYS_DIRECTORY_ANALYSIS.md
+VOD_PLAYBACK_POSSIBILITIES.md
+CLOUD_AI_IMPLEMENTATION.txt
+RECORDING_RETENTION_IMPLEMENTATION.md
+ENDPOINT_SECURITY_ANALYSIS.md
+IMPLEMENTATION_COMPLETE.md
+KAVACH_COMPLIANCE_REPORT.md
+
+# ============================================
+# LOCAL NESTED REPOS (DEV ONLY)
+# ============================================
+# AI-adapters is a separate repo
+AI-adapters/
+
+# ============================================
+
+# Temporary text files (analysis/debug)
+*_analysis.txt
+# supervisord config built into image
+!supervisord.conf
+
+# Launcher-written host network hints (mounted into opennvr-core)
+data/net-hints/
+
+# KAI-C runtime adapter-registration receipts (#371) — machine state,
+# never source. In Docker this lives on the opennvr_kai_c_state volume.
+kai-c-state/
+
+# make sdk-docs output (generated, see docs/SDK_REFERENCE.md)
+sdk/opennvr-app-sdk/docs/api/

opennvr_app_sdk-0.4.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

opennvr_app_sdk-0.4.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.5
+Name: opennvr-app-sdk
+Version: 0.4.0
+Summary: Shared SDK for OpenNVR monitoring apps: §11.5 alert dispatch, zone geometry, keyed TTL state, app manifests, and the Detector / FrameApp base loops.
+Project-URL: Homepage, https://opennvr.org
+Project-URL: Documentation, https://github.com/open-nvr/open-nvr/blob/main/docs/SDK_REFERENCE.md
+Project-URL: Developer program, https://github.com/open-nvr/open-nvr/blob/main/docs/DEVELOPER_PROGRAM.md
+Project-URL: Source, https://github.com/open-nvr/open-nvr/tree/main/sdk/opennvr-app-sdk
+Project-URL: Changelog, https://github.com/open-nvr/open-nvr/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/open-nvr/open-nvr/issues?q=label%3Asdk
+Author: OpenNVR contributors
+License: Apache-2.0
+License-File: LICENSE
+Keywords: computer-vision,nvr,opennvr,sdk,surveillance,video
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.11
+Requires-Dist: httpx<1.0,>=0.27
+Requires-Dist: nats-py>=2.6
+Requires-Dist: pyyaml<7.0,>=6.0
+Requires-Dist: websockets>=13.0
+Description-Content-Type: text/markdown
+
+# opennvr-app-sdk
+
+The SDK for building vision apps on [OpenNVR](https://opennvr.org), the
+self-hosted AI video platform. Cameras, Tier-0 detections, pluggable
+inference, an event bus, recordings, an operator alert inbox, users and
+per-camera permissions, and a catalog every deployment opens — all
+already running. You write the rule, the model or the workflow; this
+package is the only import you need.
+
+Apache-2.0 — ship your app under any licence, closed included.
+
+```bash
+pip install opennvr-app-sdk
+```
+
+## A detector in one method
+
+```python
+from opennvr_app_sdk import Alert, AppManifest, Detector, Param, app
+
+class Loitering(Detector):
+    manifest = AppManifest(
+        id="loitering", name="Loitering", version="1.0.0", category="perimeter",
+        requires_tasks=["object_detection"],
+        params=[Param("dwell_s", float, default=30.0)],
+    )
+
+    def setup(self):
+        self.present = self.keyed_state(ttl=10.0)   # forgets a camera 10 s after the last person
+
+    def on_detections(self, camera_id, detections, event):
+        people = [d for d in detections if d.get("label") == "person"]
+        if not people:
+            return
+        rec = self.present.touch(camera_id)
+        if rec.age >= self.cfg.dwell_s and not rec.alerted:
+            rec.alerted = True
+            yield Alert(title="Loitering", description=f"{len(people)} person(s) for {rec.age:.0f}s",
+                        camera_id=camera_id, severity="medium")
+
+if __name__ == "__main__":
+    raise SystemExit(app(Loitering).run())
+```
+
+That app subscribes to the platform's detections, serves the registry
+contract (`/health`, `/state`, `/manifest`, config form, actions),
+registers itself in the App Catalog, is issued its own credential, and
+fires alerts that reach the operator inbox — none of which you wrote.
+
+## The platform, from an app
+
+```python
+from opennvr_app_sdk import OpenNVR            # or opennvr_app_sdk.aio.AsyncOpenNVR
+
+nvr = OpenNVR()                                 # OPENNVR_URL + the app's key
+for cam in nvr.cameras():                       # only cameras assigned to this app
+    jpeg = nvr.snapshot(cam)
+    det = nvr.ai.infer("yolov8", jpeg, task="object_detection", camera_id=cam.handle)
+nvr.state.set("last_seen", {"cam1": 12.5})      # durable, survives restarts
+clips = nvr.recordings("cam1").list(start="2026-09-05T00:00:00Z")
+mine = nvr.alerts.inbox(unacked=True)
+```
+
+## Where to go next
+
+* [Developer program](https://github.com/open-nvr/open-nvr/blob/main/docs/DEVELOPER_PROGRAM.md) — the deal: no fee, your licence, the compatibility promise.
+* [Your first detector](https://github.com/open-nvr/open-nvr/blob/main/docs/FIRST_DETECTOR.md) — scaffold, run against a stack, list in the catalog.
+* [SDK reference](https://github.com/open-nvr/open-nvr/blob/main/docs/SDK_REFERENCE.md) — every public name, by task.
+* [Platform client](https://github.com/open-nvr/open-nvr/blob/main/docs/APP_PLATFORM.md), [app surfaces](https://github.com/open-nvr/open-nvr/blob/main/docs/APP_SURFACES.md), [credentials](https://github.com/open-nvr/open-nvr/blob/main/docs/APP_CREDENTIALS.md), [event contracts](https://github.com/open-nvr/open-nvr/blob/main/docs/EVENT_CONTRACTS.md).
+* [Example apps](https://github.com/open-nvr/open-nvr/tree/main/examples) — thirteen first-party apps built on this SDK.
+
+Compatibility: the app-registry contract is versioned (`api_version`)
+and tested in the OpenNVR repository on every change; `min_sdk_version`
+only moves when an older SDK would misbehave. Issues tagged `sdk` at
+[open-nvr/open-nvr](https://github.com/open-nvr/open-nvr/issues).

opennvr_app_sdk-0.4.0/README.md

@@ -0,0 +1,75 @@
+# opennvr-app-sdk
+
+The SDK for building vision apps on [OpenNVR](https://opennvr.org), the
+self-hosted AI video platform. Cameras, Tier-0 detections, pluggable
+inference, an event bus, recordings, an operator alert inbox, users and
+per-camera permissions, and a catalog every deployment opens — all
+already running. You write the rule, the model or the workflow; this
+package is the only import you need.
+
+Apache-2.0 — ship your app under any licence, closed included.
+
+```bash
+pip install opennvr-app-sdk
+```
+
+## A detector in one method
+
+```python
+from opennvr_app_sdk import Alert, AppManifest, Detector, Param, app
+
+class Loitering(Detector):
+    manifest = AppManifest(
+        id="loitering", name="Loitering", version="1.0.0", category="perimeter",
+        requires_tasks=["object_detection"],
+        params=[Param("dwell_s", float, default=30.0)],
+    )
+
+    def setup(self):
+        self.present = self.keyed_state(ttl=10.0)   # forgets a camera 10 s after the last person
+
+    def on_detections(self, camera_id, detections, event):
+        people = [d for d in detections if d.get("label") == "person"]
+        if not people:
+            return
+        rec = self.present.touch(camera_id)
+        if rec.age >= self.cfg.dwell_s and not rec.alerted:
+            rec.alerted = True
+            yield Alert(title="Loitering", description=f"{len(people)} person(s) for {rec.age:.0f}s",
+                        camera_id=camera_id, severity="medium")
+
+if __name__ == "__main__":
+    raise SystemExit(app(Loitering).run())
+```
+
+That app subscribes to the platform's detections, serves the registry
+contract (`/health`, `/state`, `/manifest`, config form, actions),
+registers itself in the App Catalog, is issued its own credential, and
+fires alerts that reach the operator inbox — none of which you wrote.
+
+## The platform, from an app
+
+```python
+from opennvr_app_sdk import OpenNVR            # or opennvr_app_sdk.aio.AsyncOpenNVR
+
+nvr = OpenNVR()                                 # OPENNVR_URL + the app's key
+for cam in nvr.cameras():                       # only cameras assigned to this app
+    jpeg = nvr.snapshot(cam)
+    det = nvr.ai.infer("yolov8", jpeg, task="object_detection", camera_id=cam.handle)
+nvr.state.set("last_seen", {"cam1": 12.5})      # durable, survives restarts
+clips = nvr.recordings("cam1").list(start="2026-09-05T00:00:00Z")
+mine = nvr.alerts.inbox(unacked=True)
+```
+
+## Where to go next
+
+* [Developer program](https://github.com/open-nvr/open-nvr/blob/main/docs/DEVELOPER_PROGRAM.md) — the deal: no fee, your licence, the compatibility promise.
+* [Your first detector](https://github.com/open-nvr/open-nvr/blob/main/docs/FIRST_DETECTOR.md) — scaffold, run against a stack, list in the catalog.
+* [SDK reference](https://github.com/open-nvr/open-nvr/blob/main/docs/SDK_REFERENCE.md) — every public name, by task.
+* [Platform client](https://github.com/open-nvr/open-nvr/blob/main/docs/APP_PLATFORM.md), [app surfaces](https://github.com/open-nvr/open-nvr/blob/main/docs/APP_SURFACES.md), [credentials](https://github.com/open-nvr/open-nvr/blob/main/docs/APP_CREDENTIALS.md), [event contracts](https://github.com/open-nvr/open-nvr/blob/main/docs/EVENT_CONTRACTS.md).
+* [Example apps](https://github.com/open-nvr/open-nvr/tree/main/examples) — thirteen first-party apps built on this SDK.
+
+Compatibility: the app-registry contract is versioned (`api_version`)
+and tested in the OpenNVR repository on every change; `min_sdk_version`
+only moves when an older SDK would misbehave. Issues tagged `sdk` at
+[open-nvr/open-nvr](https://github.com/open-nvr/open-nvr/issues).