continuityguard-cli 0.1.0__tar.gz

continuityguard_cli-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+venv/
+dist/
+build/
+.pytest_cache/
+*.rgb
+continuityguard-report.json

continuityguard_cli-0.1.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.

continuityguard_cli-0.1.0/PKG-INFO

@@ -0,0 +1,296 @@
+Metadata-Version: 2.4
+Name: continuityguard-cli
+Version: 0.1.0
+Summary: Local, zero-network CLI and library that scores AI-generated short-drama video clips for character-consistency drift and physics-plausibility issues before you re-render.
+Project-URL: Homepage, https://github.com/RudrenduPaul/ContinuityGuard
+Project-URL: Repository, https://github.com/RudrenduPaul/ContinuityGuard
+Project-URL: Bug Tracker, https://github.com/RudrenduPaul/ContinuityGuard/issues
+Project-URL: Changelog, https://github.com/RudrenduPaul/ContinuityGuard/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/RudrenduPaul/ContinuityGuard/blob/main/docs/getting-started.md
+Project-URL: Author - Rudrendu Paul, https://github.com/RudrenduPaul
+Project-URL: Author - Sourav Nandy, https://github.com/Sourav-nandy-ai
+Author: Rudrendu Paul, Sourav Nandy
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai-video,character-consistency,cli,ffmpeg,local-first,offline,onnxruntime,short-drama,video-qa
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.9
+Requires-Dist: numpy<3,>=1.24
+Requires-Dist: onnxruntime<2,>=1.20
+Provides-Extra: dev
+Requires-Dist: build<2,>=1.0; extra == 'dev'
+Requires-Dist: pytest<9,>=7.0; extra == 'dev'
+Requires-Dist: twine<7,>=5.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# continuityguard-cli (Python)
+
+A local, zero-network CLI and library that scores already-generated AI
+short-drama video clips for character-consistency drift and
+physically-implausible motion, before you spend render credits finding out
+the hard way.
+
+[![PyPI version](https://img.shields.io/pypi/v/continuityguard-cli.svg)](https://pypi.org/project/continuityguard-cli/)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/RudrenduPaul/ContinuityGuard/blob/main/LICENSE)
+[![Python versions](https://img.shields.io/pypi/pyversions/continuityguard-cli.svg)](https://pypi.org/project/continuityguard-cli/)
+
+## Why this exists
+
+AI short-drama generation ships hundreds of new titles a day, and every
+title is assembled from many separately generated shots. Generation models
+drift: a character's face shifts slightly between cuts, or a motion jumps
+in a way that reads as physically wrong the moment a human watches it.
+Catching that after render is expensive. ContinuityGuard scans a folder of
+already-generated clips and flags the shots worth a second look before you
+commit to a re-render. This package is the Python distribution -- a
+genuine, independent port of the
+[TypeScript/npm CLI](https://github.com/RudrenduPaul/ContinuityGuard), not
+a wrapper around a Node process. It ships the exact same bundled
+MobileNetV2 ONNX model file the TypeScript side uses, so both runtimes
+score identical input against the same weights.
+
+**Honest note on the npm side:** as of this package's release, the
+TypeScript/npm distribution of ContinuityGuard has not been published to
+the npm registry yet (the repo's own README says so, and the npm registry
+has no `continuityguard-cli` entry) -- this PyPI package is the first
+published, installable distribution of ContinuityGuard. If you want the
+TypeScript source today, clone the repo and build from source (see the
+[project README](https://github.com/RudrenduPaul/ContinuityGuard#readme)).
+
+## Install
+
+```bash
+pip install continuityguard-cli
+```
+
+or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add continuityguard-cli
+```
+
+You also need a system `ffmpeg` install (`brew install ffmpeg` on macOS,
+`apt install ffmpeg` on Debian/Ubuntu) -- see "Requirements" below for why
+ffmpeg is not bundled. Everything else -- the 14MB MobileNetV2 ONNX model,
+the scoring logic, the CLI -- ships inside the wheel; nothing else is
+fetched at scan time.
+
+## Quickstart
+
+Clone the repo to get the bundled fixture clips (not part of the published
+wheel -- they're demo/test content):
+
+```bash
+git clone https://github.com/RudrenduPaul/ContinuityGuard.git
+cd ContinuityGuard
+continuityguard scan src/score/testdata/clips
+```
+
+Real output, from this repo's own committed synthetic fixtures (no real
+short-drama footage was available for this port; every number is
+reproducible against the fixtures, not illustrative):
+
+```
+$ continuityguard scan src/score/testdata/clips
+
+ContinuityGuard v0.1 -- Local Character-Consistency & Physics-QA Scoring
+
+Scanning: /path/to/ContinuityGuard/src/score/testdata/clips (8 clips, ffmpeg decode)
+
+[SCORED] CG01 Clip Ingestion
+  8 clips decoded, 51 frames extracted
+
+[SCORED] CG02 Character-Consistency Scoring
+  3 named characters tracked across 8 clips
+  1 shot(s) flagged: low cross-shot similarity (below 0.88 cosine threshold)
+    kenji_shot02.mp4 -- "kenji" similarity 0.77 vs. reference (kenji_shot01.mp4)
+  NOTE: consistency scoring is best-validated on photorealistic content.
+  Accuracy on stylized/anime-adjacent character designs is unverified --
+  treat flags on stylized content as a prompt for human review, not a
+  confirmed defect. See README "Known limitations."
+
+[SCORED] CG03 Physics-Plausibility Heuristic
+  2 shot(s) flagged: frame-to-frame motion discontinuity above threshold
+    action-discontinuity.mp4 @ frame 4-5 -- discontinuity 8.25x local baseline
+    action-discontinuity.mp4 @ frame 5-6 -- discontinuity 8.32x local baseline
+  This is a heuristic proxy, not a physics simulator. It flags shots for
+  human review. It does not "detect" a physics violation.
+
+Report written to ./continuityguard-report.json
+Human-readable summary above. Use --json for the full structured report.
+Scan time: <N>s. Nothing left this machine. No network calls were made.
+```
+
+These are the same fixtures and the same threshold/multiplier constants
+(`CONSISTENCY_SIMILARITY_THRESHOLD = 0.88`, `DISCONTINUITY_MULTIPLIER = 3`)
+as the TypeScript source -- see the root `CHANGELOG.md` "CG02/CG03 fixture
+calibration" entries for the exact raw numbers those constants came from.
+
+Or call the library directly (the agent-native path):
+
+```python
+from continuityguard import scan
+
+report = scan("./generated-clips")
+print(f"{len(report.character_consistency.flagged_shots)} consistency flag(s)")
+for flag in report.physics_plausibility.flagged_shots:
+    print(f"{flag.clip} @ frame {flag.frame_index_a}-{flag.frame_index_b}: {flag.reason}")
+```
+
+## CLI reference
+
+Real, current `--help` output from the installed CLI:
+
+```
+$ continuityguard --help
+usage: continuityguard [-h] [-V] {scan} ...
+
+Free, local-first CLI that scores already-generated AI short-drama clips/frames
+for character-consistency and physics-plausibility problems. Zero network calls.
+
+positional arguments:
+  {scan}
+    scan         scan a directory of generated clips for character-consistency
+                 and physics-plausibility flags
+
+options:
+  -h, --help     show this help message and exit
+  -V, --version  show program's version number and exit
+
+$ continuityguard scan --help
+usage: continuityguard scan [-h] [--json] [--fps FPS] [--out OUT] directory
+
+scan a directory of generated clips for character-consistency and
+physics-plausibility flags
+
+positional arguments:
+  directory   directory of video clips to scan
+
+options:
+  -h, --help  show this help message and exit
+  --json      print the full machine-readable JSON report to stdout instead
+              of a terminal summary
+  --fps FPS   frame sample rate for ingestion (default: 2.3)
+  --out OUT   path to write the JSON report file to (default:
+              ./continuityguard-report.json)
+```
+
+### Naming your clips so CG02 can track characters
+
+CG02 infers which character a clip belongs to from its filename, using a
+`<character>_<shot-id>.<ext>` convention (for example `mei_shot01.mp4`,
+`mei_shot02.mp4`). Clips sharing a character prefix are compared against
+that character's first-seen shot. Clips that don't match the convention are
+still decoded and scored by CG03, just not compared for character
+consistency.
+
+## How it works
+
+```
+directory of clips -> ffmpeg frame extraction (CG01, 2.3fps, 224x224 RGB24)
+   -> MobileNetV2 ONNX embeddings, cosine similarity vs. reference shot (CG02)
+   -> frame-to-frame diff vs. shot's own local median baseline (CG03)
+   -> terminal report + JSON report (CG04)
+```
+
+Full module-by-module documentation is in
+[docs/concepts.md](https://github.com/RudrenduPaul/ContinuityGuard/blob/main/docs/concepts.md).
+
+## Requirements
+
+- Python >= 3.9.
+- A system `ffmpeg` install on `PATH`. Not bundled: a static per-platform
+  ffmpeg build would be materially larger than this package's own
+  dependency footprint and its licensing terms shift between LGPL and GPL
+  depending on which codecs are compiled in -- a review this project isn't
+  taking on before there's evidence of real usage. `continuityguard scan`
+  checks for ffmpeg at startup and prints the exact install command for
+  your OS if it's missing.
+
+## Known limitations (read before trusting a flag)
+
+Identical caveats to the TypeScript CLI, since both run the same scoring
+logic against the same model:
+
+- Character-consistency scoring is best-validated on photorealistic
+  content. Its accuracy on stylized or anime-adjacent character designs,
+  which describes most short-drama content, is genuinely unverified.
+- The consistency embedding (MobileNetV2's ImageNet-logit vector) measures
+  general visual similarity -- color, texture, coarse shape -- not a
+  dedicated face-identity embedding. See
+  `src/continuityguard/score/models/NOTICE.md` for why this model was used
+  instead of a purpose-built face/CLIP embedding model.
+- Physics-plausibility scoring is a frame-to-frame diff heuristic, not a
+  physics simulator. Expect both false positives (legitimate fast motion,
+  stylized jump-cuts) and false negatives.
+- Thresholds are calibrated on a small, fully synthetic fixture set
+  (solid-color clips, no real faces or recorded motion). See the root
+  `CHANGELOG.md` for the exact numbers and the command that produced them.
+
+## Fidelity to the TypeScript source
+
+This is a line-for-line port of the scoring math (`preprocess_frame`,
+`cosine_similarity`, `compute_frame_diff`, `detect_discontinuities`) and
+uses the identical bundled `mobilenetv2-7.onnx` weights. On this repo's
+own fixture clips, the Python CLI reproduces the same flagged shots at the
+same thresholds as the TypeScript CLI's documented benchmark (see the root
+README's "What it does" section for the reference numbers). Floating-point
+inference results can differ in the last few decimal places between
+`onnxruntime` (Python) and `onnxruntime-node` (the same underlying ONNX
+Runtime project, different language binding) on some hardware; this does
+not change which shots cross the fixed 0.88 / 3x thresholds on the
+committed fixtures.
+
+## CI integration
+
+```yaml
+- uses: actions/checkout@v4
+- uses: actions/setup-python@v5
+  with:
+    python-version: '3.12'
+- run: sudo apt-get update && sudo apt-get install -y ffmpeg
+- run: pip install continuityguard-cli
+- run: continuityguard scan ./generated-clips --json --out report.json
+```
+
+Full walkthrough in
+[docs/integrations/ci.md](https://github.com/RudrenduPaul/ContinuityGuard/blob/main/docs/integrations/ci.md).
+
+## Security
+
+ContinuityGuard never `eval()`s or dynamically executes anything read from
+a scanned clip; clip bytes are only ever decoded by ffmpeg (invoked with an
+explicit argument list, never a shell string) and read back as raw pixel
+data. See
+[SECURITY.md](https://github.com/RudrenduPaul/ContinuityGuard/blob/main/SECURITY.md)
+for the disclosure process. **Honest note**: this project does not
+currently publish SLSA provenance, Sigstore signatures, or an SBOM, and has
+no OpenSSF Scorecard badge -- none of that infrastructure exists yet, so it
+isn't claimed here.
+
+## Contributing
+
+See [CONTRIBUTING.md](https://github.com/RudrenduPaul/ContinuityGuard/blob/main/CONTRIBUTING.md).
+
+```bash
+cd python
+python3 -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+Apache 2.0, see [LICENSE](https://github.com/RudrenduPaul/ContinuityGuard/blob/main/LICENSE).