vexy-speakup 1.0.0__tar.gz

vexy_speakup-1.0.0/.gitignore

@@ -0,0 +1,241 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+.omc/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# hatch-vcs writes the version file at build time.
+__version__.py
+
+# Private recordings, processing runs and evidence never belong in this repo.
+.DS_Store
+*.mp4
+*.m4a
+*.mp3
+*.wav
+*.flac
+*.aif
+*.aiff
+*.ogg
+*.opus
+*_improved*
+*_attempts/
+run-*/
+evidence/
+private/

vexy_speakup-1.0.0/CHANGELOG.md

@@ -0,0 +1,16 @@
+<!-- this_file: CHANGELOG.md -->
+# Changelog
+
+## 1.0.0
+- Added `build.sh` (test, build, twine check) and `publish.sh` (test,
+  gitnextver tag, build, `uv publish` with retry on rate limits).
+- Ported the `speech-polish` script collection into the installable
+  `vexy_speakup` src-layout package with a `vexy-speakup` Fire CLI.
+- Versions now come from git tags through hatch-vcs; the generated
+  `__version__.py` is ignored by git. Added a `version` command.
+- Plugin workers run as `python -m vexy_speakup`, so the installed package
+  needs no adjacent script.
+- Replaced machine-specific paths: plugins default to
+  `/Library/Audio/Plug-Ins/VST3` (`VEXY_SPEAKUP_PLUGIN_ROOT`), and local model
+  adapters come from `VEXY_SPEAKUP_TTS_ROOT`, resolved only when used.
+- Folded the standalone plugin probe script into the `probe` command.

vexy_speakup-1.0.0/DEPENDENCIES.md

@@ -0,0 +1,15 @@
+<!-- this_file: DEPENDENCIES.md -->
+# Dependencies
+
+Fire (CLI, matching vexy-subs), NumPy (sample buffers, gains and fades),
+Pedalboard 0.9.26 (VST3 hosting with latency compensation; pinned because the
+plugin rendering was verified with this exact wheel), SoundFile (float/RF64 WAV
+streaming), pyloudnorm (BS.1770 speaker and fragment loudness).
+
+FFmpeg/ffprobe are external executables for decoding, R128 levelling, encoding
+and video remuxing. Diarization, DeepFilterNet and DNSMOS/UTMOS scoring use
+existing local adapters in their own uv environments; they are not package
+dependencies. Commercial VST3 plugins are user-installed and not distributed.
+
+Build: hatchling with hatch-vcs (version from git tags).
+Tests/build: pytest, pytest-cov, ruff, build and twine.

vexy_speakup-1.0.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.

vexy_speakup-1.0.0/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 2.5
+Name: vexy-speakup
+Version: 1.0.0
+Summary: Diarize, restore, level and master recorded speech with local VST3 plugins, keeping the video timeline
+Project-URL: Repository, https://github.com/vexyart/vexy-speakup
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Environment :: Console
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
+Requires-Python: >=3.12
+Requires-Dist: fire<0.8,>=0.7.1
+Requires-Dist: numpy<3,>=2
+Requires-Dist: pedalboard==0.9.26
+Requires-Dist: pyloudnorm<0.3,>=0.2
+Requires-Dist: soundfile<0.14,>=0.13.1
+Provides-Extra: test
+Requires-Dist: build>=1.2; extra == 'test'
+Requires-Dist: pytest-cov>=6; extra == 'test'
+Requires-Dist: pytest>=8; extra == 'test'
+Requires-Dist: ruff>=0.12; extra == 'test'
+Requires-Dist: twine>=6; extra == 'test'
+Description-Content-Type: text/markdown
+
+<!-- this_file: README.md -->
+# vexy-speakup
+
+Restore a meeting recording with your installed VST3 speech plugins, one speaker
+at a time, and get back the same file with the original video timeline intact.
+
+```bash
+uv tool install vexy-speakup
+# From a checkout before the first release:
+uv tool install .
+vexy-speakup run meeting.mp4 --profile_name=dx65 --verbose
+```
+
+It requires macOS, Python 3.12+ and FFmpeg/ffprobe on PATH. Rendering uses the
+tested Pedalboard 0.9.26 wheel. The built-in profiles expect Accentize dxRevive
+Pro, iZotope RX 12 Voice De-noise and Ozone 12 Maximizer. Plugins are read from
+`/Library/Audio/Plug-Ins/VST3`. Set `VEXY_SPEAKUP_PLUGIN_ROOT` to use another
+folder. Plugins and their licences are yours; none are distributed here.
+
+## Commands
+
+```bash
+# Full audio or video, default work and output paths
+vexy-speakup run meeting.m4a --profile_name=dx65
+
+# Explicit paths and loudness
+vexy-speakup run meeting.mp4 \
+  --work_dir=work --output_path=result.mp4 \
+  --target_lufs=-16 --true_peak=-2 --verbose
+
+# Compare three processing attempts on one excerpt and retain model scores
+vexy-speakup attempts meeting.m4a --work_dir=comparison --start=120 --duration=45
+
+# Audio-only preview (video previews need a pretrimmed video)
+vexy-speakup run meeting.m4a --start=120 --duration=45
+
+# Export audio only from a video
+vexy-speakup run meeting.mp4 --output_path=speech.wav
+
+# Optional local DeepFilterNet3 CoreML before VST processing
+vexy-speakup run meeting.m4a --ai=deepfilter
+
+# Reuse or correct speaker annotations instead of rerunning a model
+vexy-speakup run meeting.m4a --diarization_json=turns.json
+
+# Alternate local diarizer; four speaker slots
+vexy-speakup run meeting.m4a --diarizer=sortformer
+
+# Inspect actual plugin controls before writing a custom chain
+vexy-speakup inspect /Library/Audio/Plug-Ins/VST3/Accentize-dxRevivePro.vst3
+vexy-speakup probe /Library/Audio/Plug-Ins/VST3/Accentize-dxRevivePro.vst3 probe.json
+vexy-speakup inventory --output_path=inventory.json
+vexy-speakup version
+```
+
+For `meeting.mp4`, the defaults are a work folder `meeting/` and an output file
+`meeting_improved.mp4`, beside the input. Audio follows the same naming rule and
+keeps its extension. Audio previews add `_preview`. An existing output is
+refused unless `--force` is supplied. Every run gets a new directory inside the
+work folder, so previous attempts and originals stay available.
+
+## Local models
+
+Diarization, DeepFilterNet and quality scoring call existing local adapters and
+native hosts in isolated uv environments. Set `VEXY_SPEAKUP_TTS_ROOT` to the
+folder holding `myasr/`, `myaud/` and `.external/`. Without it, you can still
+process a recording with `--diarization_json=turns.json --evaluate=False`.
+
+The default diarizer is the cached `mlx-community/Nemotron-3-Diarization-8bit`
+conversion via `myasr/tools/diarize-mlx.py`. Sortformer uses the pinned Q8 GGUF
+from the Hugging Face cache and the native `nemo-speech` host. No paid service is
+used, and model access runs with `HF_HUB_OFFLINE=1`.
+
+Evaluation invokes the cached `aud-metrics` environment and its DNSMOS/UTMOS
+ONNX predictors. Override its Python with `--metrics_python=...` or disable
+scoring with `--evaluate=False`. Missing predictors appear as errors in reports;
+they never become synthetic scores. Normal runs score up to three matching
+30-second speech windows.
+
+## Profiles and custom chains
+
+`dx35` is the conservative default: dxRevive at 35%, followed by Ozone Maximizer.
+`dx65` raises restoration to 65%; it led DNSMOS on the tested Zoom excerpt.
+`rx6-dx35` adds RX Voice De-noise at 6 dB before dxRevive.
+`rx6` uses RX alone. `bypass` skips VSTs but keeps the level passes.
+
+Use `--config_path=custom-chain.json` to replace the chains. The bundled
+[example](examples/custom-chain.example.json) gives speaker `0` a lighter
+dxRevive setting and mouth de-clicking. `speech` is the shared default chain,
+`speakers` overrides individual speaker IDs, and `master` runs continuously after
+assembly. Each plugin entry accepts `path`, `parameters`, optional `plugin_name`
+for a multi-plugin bundle, and optional `preset` for a saved `.vstpreset` file.
+Parameter names are validated against the installed plugin; unknown names fail.
+Saved presets should come from your own host and installed plugin version.
+
+## Processing and files
+
+1. FFmpeg extracts stereo float PCM at 48 kHz. A delayed video audio start
+   becomes leading silence. Diarization receives the original signal; optional
+   AI restoration happens afterwards.
+2. The diarizer processes the complete audio with its own bounded context, so
+   speaker IDs are not restarted for each fragment.
+3. The timeline is partitioned into disjoint speech, overlap and background
+   intervals of at most 30 seconds (`--max_chunk`). Each speech fragment
+   carries half a second of context at each edge.
+4. One isolated plugin worker (`python -m vexy_speakup _render`) processes each
+   speaker and resets the chain between fragments. Stereo is retained. Two
+   seconds of padding drain plugin buffering; Pedalboard compensates reported
+   plugin latency.
+5. A duration-weighted median calibrates each speaker. Turn adjustments stay
+   within 3 dB of that baseline, and total gain within ±12 dB. Silence is never
+   amplified. Processing transitions blend with the source over 10 ms.
+6. Timeline assembly writes every sample exactly once. Background gaps remain.
+   Overlap is processed once as a mixed fragment under `speakers/_overlap`.
+7. Two-pass R128 levelling precedes continuous mastering; a measured pass then
+   sets final loudness and true peak. Export checks the encoded true peak and
+   attenuates and re-encodes if lossy encoding overshoots.
+8. For video, FFmpeg copies the original video packets and replaces the audio.
+
+`speakers/<ID>/*.wav` are levelled timeline fragments; `*-context.wav` and
+`*-render.wav` keep their processing context. `*-mastered.wav` are 24-bit cuts
+from the final master, with final levels and the full-recording limiter
+behaviour. `fragments.json` records original times, sample offsets, active
+speakers and gains. Intermediate WAVs are float PCM and may exceed 0 dBFS;
+`master.wav` and the published output are the peak-controlled deliverables.
+A long recording can consume tens of GB of work files.
+
+`turns.json`, diarization receipts, `speaker-gains.json`, VST parameter
+receipts, `report.json`, `evaluation.json`, subprocess logs and `latest.json`
+make each run reviewable. A failed run records its error and keeps its work
+files. A successful output is published through a temporary file and rename.
+
+## Limits
+
+Predictor scores guide comparisons. They do not establish speaker accuracy,
+transcript preservation or perceptual quality across a whole meeting. Diarized
+fragments are not isolated voices during simultaneous speech; that would need
+separate microphone tracks or a tested separation model. Speaker IDs are
+anonymous until you label them.
+
+Recordings, turn files and run folders are your private data. They are excluded
+from the source and wheel allowlists, and nothing is uploaded.
+
+## Development
+
+```bash
+./test.sh                 # pytest with coverage, then ruff
+./build.sh                # tests, uv build, twine check; version from git tag
+./publish.sh              # tag, build, uv publish to PyPI
+```
+
+Tag releases with `uvx gitnextver`. Untagged commits build as development
+versions with a local segment, which PyPI rejects. The generated
+`src/vexy_speakup/__version__.py` is ignored by git.
+
+`./publish.sh` runs the tests, then `uvx gitnextver`, which commits all
+changes, creates the next `vX.Y.Z` tag (`v1.0.0` when none exists) and pushes.
+It then builds and runs `uv publish`. A rerun on a clean, already tagged HEAD
+skips gitnextver.