open-redactor 0.2.0__tar.gz

open_redactor-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

open_redactor-0.2.0/PKG-INFO

@@ -0,0 +1,216 @@
+Metadata-Version: 2.4
+Name: open-redactor
+Version: 0.2.0
+Summary: Open-source CLI to make video share-safe with SAM 3.1 prompt-driven redaction
+Author: Yuriy H
+License: Apache-2.0
+Keywords: video,redaction,sam,privacy,cli
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.26
+Requires-Dist: Pillow>=10.0
+Requires-Dist: opencv-python-headless>=4.8
+Requires-Dist: httpx>=0.25
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4; extra == "dev"
+Requires-Dist: pytest-cov>=4.1; extra == "dev"
+Provides-Extra: pii
+Requires-Dist: pytesseract>=0.3.10; extra == "pii"
+Requires-Dist: pandas>=2.0; extra == "pii"
+Provides-Extra: local
+Requires-Dist: torch>=2.2; extra == "local"
+Requires-Dist: transformers>=4.44; extra == "local"
+Requires-Dist: accelerate>=0.33; extra == "local"
+Dynamic: license-file
+
+# Open Redactor
+
+**Drop in a clip or a photo, name what to hide, get a share-safe copy out.**
+
+Open Redactor finds people, faces, documents, numbers, codes, and places in your media and covers them with tracking that holds across every frame. Blur it, pixelate it, or swap it for a generated stand-in. Audit before you redact, prove coverage after, and keep private footage on your own machine when it matters.
+
+![Redacted output](examples/media/hero.gif)
+
+*Original on the left, redacted output on the right, from a live SAM 3.1 run. The face track held across all 50 frames.*
+
+## Try it in 30 seconds
+
+```bash
+pip install open-redactor
+
+open-redactor clip.mp4 --preview --preset family     # 3 second sample first
+cat clip.redacted.coverage.txt                        # one result line to trust
+open-redactor clip.mp4 --preset family                # the full run
+open-redactor clip.mp4 --preset family --mode pixelate  # re-render free, detection is cached
+```
+
+## What it catches
+
+**People and places, by phrase.** Person, face, license plate, screen, and anything else you name in a short noun phrase. The tracker holds each one across time, pads the mask, and carries it through brief dropouts so the output never flashes clean.
+
+**Sensitive documents.** Passports, credit cards, driver licenses, ID cards, documents, and name badges with the documents preset.
+
+**Printed secrets.** The text layer OCRs frames and covers verified credit card numbers, Social Security numbers, phone numbers, and emails. Card numbers must pass the Luhn check, so order numbers stay untouched.
+
+**Codes.** QR codes and barcodes, which carry Wi-Fi passwords, payment links, and contact cards.
+
+**Location clues.** Street signs, house numbers, plates, and mailboxes with the location preset.
+
+**Voices.** Audio stays, gets muted, or gets pitch shifted so speech remains but the speaker does not.
+
+## Three ways to hide something
+
+| Mode | What you see | Reach for it when |
+| --- | --- | --- |
+| blur | A soft gaussian cover | You want the default, clean look |
+| pixelate | Chunky mosaic blocks | You want the classic redaction look |
+| replace | A generated stand-in | You want the scene to still feel natural |
+
+![Replace demo](examples/media/replace-demo.jpg)
+
+*Replace mode on the real showcase portrait. The face becomes a neutral synthetic avatar while the photo around it stays untouched. The same treatment swaps plates and house numbers for fake plaques and card numbers for format valid fakes in the reserved test range. Fakes are deterministic per track, so the same person keeps the same stand-in for the whole clip.*
+
+```bash
+open-redactor clip.mp4 --mode replace --preset location
+```
+
+## Trust first, share second
+
+Redaction fails silently in most tools. Open Redactor is built to show its work.
+
+**Preview.** Render only the first 3 seconds with a contact sheet before committing to a full clip.
+
+**Shadow audit.** Run detection and change nothing. You get a written audit with every element, its frames, and a severity grade, critical for passports and card numbers, high for faces and house numbers, medium for plates and signs.
+
+```bash
+open-redactor clip.mp4 --shadow --preset documents --sensitive
+```
+
+**Coverage report.** Every real run writes one. Any gap longer than the carry window is flagged NEEDS REVIEW in plain words.
+
+**Analytics.** Every run ends with frames affected, elements by severity, an exposure score, and a machine readable .summary.json next to the output.
+
+A sample audit lives at [examples/shadow-audit-sample.txt](examples/shadow-audit-sample.txt).
+
+## One flag presets
+
+```bash
+open-redactor clip.mp4 --preset family        # kids, faces, plates, screens, generous blur
+open-redactor clip.mp4 --preset street        # bystanders and plates, pixelated
+open-redactor clip.mp4 --preset screen-share  # monitors and faces in recordings
+open-redactor clip.mp4 --preset documents     # passports, cards, IDs, badges, strong blur
+open-redactor clip.mp4 --preset location      # street signs, house numbers, mailboxes
+```
+
+Add `--sensitive` to any run to switch on the text and codes layers together. Add `--audio mute` or `--audio pitch` when voices identify someone.
+
+## Run SAM wherever you trust it
+
+SAM 3.1 is an open weights model, so the backend is your choice.
+
+**API, the default.** Meta Model API, best quality with no GPU. Your clip goes to api.meta.ai with your key.
+
+```bash
+open-redactor clip.mp4 --backend api
+```
+
+**Hosted.** The same request shape pointed at your own endpoint, a team server, or a cloud GPU box.
+
+```bash
+open-redactor clip.mp4 --backend hosted --endpoint https://your-host.example/v1/responses
+```
+
+**Local.** Grounding DINO plus SAM 2 with IoU tracking on your own hardware. Nothing leaves the device. This is the mode for source footage, medical clips, and family video that should never be uploaded.
+
+```bash
+pip install "open-redactor[local]"
+open-redactor clip.mp4 --backend local
+```
+
+Pixel-perfect SAM masks decode through @meta-sam/parser when Node is present, with a box fallback that still pads and carries safely.
+
+## Photos, formats, and the local page
+
+Photos work exactly like video. JPG, PNG, WebP, and BMP in, redacted photo out in the same format, with every preset and layer available.
+
+```bash
+open-redactor photo.jpg --preset documents --sensitive
+```
+
+Video inputs cover MP4, MOV, MKV, WebM, AVI, and M4V from phones, OBS, browsers, and older cameras. Output is always MP4. Batch mode takes a whole folder. Output naming never overwrites your original or an earlier redacted copy.
+
+Prefer clicking? `open-redactor --ui` opens a drag and drop page that runs only on your own machine at 127.0.0.1.
+
+## The full demo
+
+```bash
+# 1. Audit a folder of interview footage without changing a byte
+open-redactor interview.mp4 --shadow --preset street --audio pitch
+
+# 2. Preview the fix on the first 3 seconds
+open-redactor interview.mp4 --preview --preset street --audio pitch
+
+# 3. Run it, with analytics and a coverage report written next to the output
+open-redactor interview.mp4 --preset street --audio pitch --contact-sheet
+
+# 4. Read what was caught
+cat interview.redacted.summary.json
+```
+
+More worked examples with frames and coverage proof live in [examples/README.md](examples/README.md). The longer guide, privacy notes, and honest limits live in [docs/using-open-redactor.md](docs/using-open-redactor.md).
+
+## Why this exists
+
+**Thesis:** Consumer video redaction is either manual or enterprise-priced and a prompt-driven open-source CLI makes share-safe video a one-command default.
+
+**Value-add:** Real video tracking quality without per-frame manual work plus a local mode that keeps private footage off any API.
+
+## How it stays covered
+
+A detector that drops a face for two frames leaks those two frames. So the pipeline pads every mask by a margin, carries tracks forward after they vanish, smooths mask edges over time, fills single-frame gaps, and flags any longer gap in the coverage report instead of hiding it. Defaults are a product decision too: person, face, license plate, and screen run when you name nothing.
+
+## CLI reference
+
+```text
+open-redactor input.mp4 [--output out.mp4]
+  --target PHRASE (repeatable)      --targets-default  --add-target PHRASE
+  --preset family|street|screen-share|documents|location
+  --mode blur|pixelate|replace      --strength N       --mask-margin N  --carry-frames N
+  --preview                         --shadow           --contact-sheet
+  --report (default)                --no-report
+  --sensitive                       --pii-text         --codes
+  --audio keep|mute|pitch          --pitch-factor 0.8
+  --backend api|hosted|local        --provider sam|grounding-sam
+  --endpoint URL                    --api-key-env MODEL_API_KEY
+  --no-cache                        --batch            --ui
+```
+
+Exit code is 0 on success. A run that finds zero matches still exits 0 and writes a clean copy with a log line saying nothing matched.
+
+## Install
+
+```bash
+pip install open-redactor
+pip install "open-redactor[local]"   # optional local models
+pip install "open-redactor[pii]"     # optional text scanning, also needs the tesseract binary
+```
+
+You need ffmpeg and ffprobe on your PATH. From source: clone this repo and `pip install -e .`
+
+## Project layout
+
+- `cli.py` the command line, presets, and routing for video and photos
+- `pipeline.py` and `image_pipeline.py` ingest, detection, padding, rendering, reports
+- `sam_client.py` the SAM 3.1 API and hosted client with caching
+- `local_gsam.py` Grounding DINO plus SAM 2 local provider with IoU tracking
+- `masks.py` padding, carry-forward, smoothing, and coverage reports
+- `pii.py`, `codes.py` the text and codes layers
+- `analytics.py`, `replace.py` severity, summaries, shadow audits, and generated stand-ins
+
+## License
+
+Apache-2.0. See LICENSE.

open_redactor-0.2.0/README.md

@@ -0,0 +1,187 @@
+# Open Redactor
+
+**Drop in a clip or a photo, name what to hide, get a share-safe copy out.**
+
+Open Redactor finds people, faces, documents, numbers, codes, and places in your media and covers them with tracking that holds across every frame. Blur it, pixelate it, or swap it for a generated stand-in. Audit before you redact, prove coverage after, and keep private footage on your own machine when it matters.
+
+![Redacted output](examples/media/hero.gif)
+
+*Original on the left, redacted output on the right, from a live SAM 3.1 run. The face track held across all 50 frames.*
+
+## Try it in 30 seconds
+
+```bash
+pip install open-redactor
+
+open-redactor clip.mp4 --preview --preset family     # 3 second sample first
+cat clip.redacted.coverage.txt                        # one result line to trust
+open-redactor clip.mp4 --preset family                # the full run
+open-redactor clip.mp4 --preset family --mode pixelate  # re-render free, detection is cached
+```
+
+## What it catches
+
+**People and places, by phrase.** Person, face, license plate, screen, and anything else you name in a short noun phrase. The tracker holds each one across time, pads the mask, and carries it through brief dropouts so the output never flashes clean.
+
+**Sensitive documents.** Passports, credit cards, driver licenses, ID cards, documents, and name badges with the documents preset.
+
+**Printed secrets.** The text layer OCRs frames and covers verified credit card numbers, Social Security numbers, phone numbers, and emails. Card numbers must pass the Luhn check, so order numbers stay untouched.
+
+**Codes.** QR codes and barcodes, which carry Wi-Fi passwords, payment links, and contact cards.
+
+**Location clues.** Street signs, house numbers, plates, and mailboxes with the location preset.
+
+**Voices.** Audio stays, gets muted, or gets pitch shifted so speech remains but the speaker does not.
+
+## Three ways to hide something
+
+| Mode | What you see | Reach for it when |
+| --- | --- | --- |
+| blur | A soft gaussian cover | You want the default, clean look |
+| pixelate | Chunky mosaic blocks | You want the classic redaction look |
+| replace | A generated stand-in | You want the scene to still feel natural |
+
+![Replace demo](examples/media/replace-demo.jpg)
+
+*Replace mode on the real showcase portrait. The face becomes a neutral synthetic avatar while the photo around it stays untouched. The same treatment swaps plates and house numbers for fake plaques and card numbers for format valid fakes in the reserved test range. Fakes are deterministic per track, so the same person keeps the same stand-in for the whole clip.*
+
+```bash
+open-redactor clip.mp4 --mode replace --preset location
+```
+
+## Trust first, share second
+
+Redaction fails silently in most tools. Open Redactor is built to show its work.
+
+**Preview.** Render only the first 3 seconds with a contact sheet before committing to a full clip.
+
+**Shadow audit.** Run detection and change nothing. You get a written audit with every element, its frames, and a severity grade, critical for passports and card numbers, high for faces and house numbers, medium for plates and signs.
+
+```bash
+open-redactor clip.mp4 --shadow --preset documents --sensitive
+```
+
+**Coverage report.** Every real run writes one. Any gap longer than the carry window is flagged NEEDS REVIEW in plain words.
+
+**Analytics.** Every run ends with frames affected, elements by severity, an exposure score, and a machine readable .summary.json next to the output.
+
+A sample audit lives at [examples/shadow-audit-sample.txt](examples/shadow-audit-sample.txt).
+
+## One flag presets
+
+```bash
+open-redactor clip.mp4 --preset family        # kids, faces, plates, screens, generous blur
+open-redactor clip.mp4 --preset street        # bystanders and plates, pixelated
+open-redactor clip.mp4 --preset screen-share  # monitors and faces in recordings
+open-redactor clip.mp4 --preset documents     # passports, cards, IDs, badges, strong blur
+open-redactor clip.mp4 --preset location      # street signs, house numbers, mailboxes
+```
+
+Add `--sensitive` to any run to switch on the text and codes layers together. Add `--audio mute` or `--audio pitch` when voices identify someone.
+
+## Run SAM wherever you trust it
+
+SAM 3.1 is an open weights model, so the backend is your choice.
+
+**API, the default.** Meta Model API, best quality with no GPU. Your clip goes to api.meta.ai with your key.
+
+```bash
+open-redactor clip.mp4 --backend api
+```
+
+**Hosted.** The same request shape pointed at your own endpoint, a team server, or a cloud GPU box.
+
+```bash
+open-redactor clip.mp4 --backend hosted --endpoint https://your-host.example/v1/responses
+```
+
+**Local.** Grounding DINO plus SAM 2 with IoU tracking on your own hardware. Nothing leaves the device. This is the mode for source footage, medical clips, and family video that should never be uploaded.
+
+```bash
+pip install "open-redactor[local]"
+open-redactor clip.mp4 --backend local
+```
+
+Pixel-perfect SAM masks decode through @meta-sam/parser when Node is present, with a box fallback that still pads and carries safely.
+
+## Photos, formats, and the local page
+
+Photos work exactly like video. JPG, PNG, WebP, and BMP in, redacted photo out in the same format, with every preset and layer available.
+
+```bash
+open-redactor photo.jpg --preset documents --sensitive
+```
+
+Video inputs cover MP4, MOV, MKV, WebM, AVI, and M4V from phones, OBS, browsers, and older cameras. Output is always MP4. Batch mode takes a whole folder. Output naming never overwrites your original or an earlier redacted copy.
+
+Prefer clicking? `open-redactor --ui` opens a drag and drop page that runs only on your own machine at 127.0.0.1.
+
+## The full demo
+
+```bash
+# 1. Audit a folder of interview footage without changing a byte
+open-redactor interview.mp4 --shadow --preset street --audio pitch
+
+# 2. Preview the fix on the first 3 seconds
+open-redactor interview.mp4 --preview --preset street --audio pitch
+
+# 3. Run it, with analytics and a coverage report written next to the output
+open-redactor interview.mp4 --preset street --audio pitch --contact-sheet
+
+# 4. Read what was caught
+cat interview.redacted.summary.json
+```
+
+More worked examples with frames and coverage proof live in [examples/README.md](examples/README.md). The longer guide, privacy notes, and honest limits live in [docs/using-open-redactor.md](docs/using-open-redactor.md).
+
+## Why this exists
+
+**Thesis:** Consumer video redaction is either manual or enterprise-priced and a prompt-driven open-source CLI makes share-safe video a one-command default.
+
+**Value-add:** Real video tracking quality without per-frame manual work plus a local mode that keeps private footage off any API.
+
+## How it stays covered
+
+A detector that drops a face for two frames leaks those two frames. So the pipeline pads every mask by a margin, carries tracks forward after they vanish, smooths mask edges over time, fills single-frame gaps, and flags any longer gap in the coverage report instead of hiding it. Defaults are a product decision too: person, face, license plate, and screen run when you name nothing.
+
+## CLI reference
+
+```text
+open-redactor input.mp4 [--output out.mp4]
+  --target PHRASE (repeatable)      --targets-default  --add-target PHRASE
+  --preset family|street|screen-share|documents|location
+  --mode blur|pixelate|replace      --strength N       --mask-margin N  --carry-frames N
+  --preview                         --shadow           --contact-sheet
+  --report (default)                --no-report
+  --sensitive                       --pii-text         --codes
+  --audio keep|mute|pitch          --pitch-factor 0.8
+  --backend api|hosted|local        --provider sam|grounding-sam
+  --endpoint URL                    --api-key-env MODEL_API_KEY
+  --no-cache                        --batch            --ui
+```
+
+Exit code is 0 on success. A run that finds zero matches still exits 0 and writes a clean copy with a log line saying nothing matched.
+
+## Install
+
+```bash
+pip install open-redactor
+pip install "open-redactor[local]"   # optional local models
+pip install "open-redactor[pii]"     # optional text scanning, also needs the tesseract binary
+```
+
+You need ffmpeg and ffprobe on your PATH. From source: clone this repo and `pip install -e .`
+
+## Project layout
+
+- `cli.py` the command line, presets, and routing for video and photos
+- `pipeline.py` and `image_pipeline.py` ingest, detection, padding, rendering, reports
+- `sam_client.py` the SAM 3.1 API and hosted client with caching
+- `local_gsam.py` Grounding DINO plus SAM 2 local provider with IoU tracking
+- `masks.py` padding, carry-forward, smoothing, and coverage reports
+- `pii.py`, `codes.py` the text and codes layers
+- `analytics.py`, `replace.py` severity, summaries, shadow audits, and generated stand-ins
+
+## License
+
+Apache-2.0. See LICENSE.

open_redactor-0.2.0/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "open-redactor"
+version = "0.2.0"
+description = "Open-source CLI to make video share-safe with SAM 3.1 prompt-driven redaction"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "Apache-2.0" }
+authors = [
+  { name = "Yuriy H" }
+]
+keywords = ["video", "redaction", "sam", "privacy", "cli"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: Apache Software License",
+  "Operating System :: OS Independent",
+]
+dependencies = [
+  "numpy>=1.26",
+  "Pillow>=10.0",
+  "opencv-python-headless>=4.8",
+  "httpx>=0.25",
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=7.4",
+  "pytest-cov>=4.1",
+]
+pii = [
+  "pytesseract>=0.3.10",
+  "pandas>=2.0",
+]
+local = [
+  "torch>=2.2",
+  "transformers>=4.44",
+  "accelerate>=0.33",
+]
+
+[project.scripts]
+open-redactor = "open_redactor.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

open_redactor-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

open_redactor-0.2.0/src/open_redactor/__init__.py

@@ -0,0 +1,4 @@
+"""Open Redactor."""
+
+__all__ = ["__version__"]
+__version__ = "0.2.0"