clear-record 0.1.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- clear_record-0.1.1/LICENSE +21 -0
- clear_record-0.1.1/PKG-INFO +99 -0
- clear_record-0.1.1/README.md +64 -0
- clear_record-0.1.1/pyproject.toml +66 -0
- clear_record-0.1.1/pyproject.toml.orig +66 -0
- clear_record-0.1.1/src/clear_record/__init__.py +15 -0
- clear_record-0.1.1/src/clear_record/cli/__init__.py +7 -0
- clear_record-0.1.1/src/clear_record/cli/__main__.py +4 -0
- clear_record-0.1.1/src/clear_record/cli/cli.py +403 -0
- clear_record-0.1.1/src/clear_record/cli/eval.py +66 -0
- clear_record-0.1.1/src/clear_record/cli/stages.py +746 -0
- clear_record-0.1.1/src/clear_record/cli/transcription.py +499 -0
- clear_record-0.1.1/src/clear_record/cli/workspace.py +358 -0
- clear_record-0.1.1/src/clear_record/core/__init__.py +44 -0
- clear_record-0.1.1/src/clear_record/core/model.py +143 -0
- clear_record-0.1.1/src/clear_record/core/pipeline.py +90 -0
- clear_record-0.1.1/src/clear_record/engine/__init__.py +69 -0
- clear_record-0.1.1/src/clear_record/engine/align.py +324 -0
- clear_record-0.1.1/src/clear_record/engine/attribute.py +451 -0
- clear_record-0.1.1/src/clear_record/engine/audio.py +141 -0
- clear_record-0.1.1/src/clear_record/engine/chunk.py +77 -0
- clear_record-0.1.1/src/clear_record/engine/diarize.py +288 -0
- clear_record-0.1.1/src/clear_record/engine/merge.py +135 -0
- clear_record-0.1.1/src/clear_record/engine/synth.py +388 -0
- clear_record-0.1.1/src/clear_record/engine/text.py +63 -0
- clear_record-0.1.1/src/clear_record/providers/__init__.py +49 -0
- clear_record-0.1.1/src/clear_record/providers/backends.py +829 -0
- clear_record-0.1.1/src/clear_record/providers/base.py +94 -0
- clear_record-0.1.1/src/clear_record/providers/paths.py +29 -0
- clear_record-0.1.1/src/clear_record/providers/process.py +167 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Zhao Wen Yuan
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: clear-record
|
|
3
|
+
Version: 0.1.1
|
|
4
|
+
Summary: Local-first multitrack transcription and record reconstruction: from many recordings to one clear record.
|
|
5
|
+
Keywords: cli,transcription,audio,speech-to-text,asr,pipeline,reconciliation,signal-processing,alignment,whisper,cuda,rocm,metal,backend
|
|
6
|
+
Author: zhaoweny
|
|
7
|
+
Author-email: zhaoweny <zhaoweny@users.noreply.github.com>
|
|
8
|
+
License-Expression: MIT
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Classifier: Development Status :: 4 - Beta
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: Operating System :: OS Independent
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
|
|
17
|
+
Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
|
|
18
|
+
Classifier: Topic :: Scientific/Engineering
|
|
19
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
20
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
21
|
+
Classifier: Topic :: Text Processing
|
|
22
|
+
Classifier: Environment :: Console
|
|
23
|
+
Classifier: Topic :: Utilities
|
|
24
|
+
Requires-Dist: numpy>=2.0
|
|
25
|
+
Requires-Dist: soundfile>=0.12
|
|
26
|
+
Requires-Python: >=3.12
|
|
27
|
+
Project-URL: Homepage, https://github.com/zhaoweny/clear-record
|
|
28
|
+
Project-URL: Repository, https://github.com/zhaoweny/clear-record
|
|
29
|
+
Project-URL: Issues, https://github.com/zhaoweny/clear-record/issues
|
|
30
|
+
Provides-Extra: all
|
|
31
|
+
Provides-Extra: amd
|
|
32
|
+
Provides-Extra: apple
|
|
33
|
+
Provides-Extra: nvidia
|
|
34
|
+
Description-Content-Type: text/markdown
|
|
35
|
+
|
|
36
|
+
# clear-record
|
|
37
|
+
|
|
38
|
+
**Local-first multitrack transcription and record reconstruction:** ingest several
|
|
39
|
+
recordings of one event, align them onto a common timebase, transcribe them
|
|
40
|
+
locally, and reconcile **one clear, attributed record** — *from many recordings to
|
|
41
|
+
one clear record*.
|
|
42
|
+
|
|
43
|
+
Entirely offline after a one-time model download: no cloud, no telemetry, no
|
|
44
|
+
account.
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
# from PyPI
|
|
48
|
+
uvx clear-record --help # run it without installing
|
|
49
|
+
uv tool install clear-record # or: pipx install clear-record
|
|
50
|
+
|
|
51
|
+
# from a source checkout
|
|
52
|
+
uv sync --all-packages --extra apple
|
|
53
|
+
uv run --all-packages --extra apple clear-record --help
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## The pipeline
|
|
57
|
+
|
|
58
|
+
One subcommand per stage; `run` chains them:
|
|
59
|
+
|
|
60
|
+
```sh
|
|
61
|
+
clear-record ingest # discover/declare the audio sources
|
|
62
|
+
clear-record align # place every source on a common clock (cross-correlation)
|
|
63
|
+
clear-record transcribe # run a local ASR backend (apple / nvidia / amd)
|
|
64
|
+
clear-record reconcile # merge into one attributed, aligned timeline
|
|
65
|
+
clear-record export # Markdown / SRT / VTT / JSON
|
|
66
|
+
clear-record run # ingest -> align -> transcribe -> reconcile -> export
|
|
67
|
+
clear-record calibrate # run it and report transcript quality against a reference
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Backends
|
|
71
|
+
|
|
72
|
+
All three drive the **system `whisper-cli`** plus a ggml plugin, so the default
|
|
73
|
+
install depends only on `numpy` and `soundfile` and never pulls a GPU framework;
|
|
74
|
+
the `apple` / `nvidia` / `amd` extras are **no-op markers** (ADR-0005).
|
|
75
|
+
`clear-record backends` reports what the current machine can actually run.
|
|
76
|
+
|
|
77
|
+
## How it is packaged
|
|
78
|
+
|
|
79
|
+
`clear-record` is a **single published distribution**: one import package,
|
|
80
|
+
`clear_record`, with four internal layers as subpackages —
|
|
81
|
+
|
|
82
|
+
| Layer | Contents |
|
|
83
|
+
|---|---|
|
|
84
|
+
| `clear_record.core` | backend-agnostic domain model (no third-party deps) |
|
|
85
|
+
| `clear_record.engine` | audio I/O, cross-correlation alignment, reconcile (numpy + soundfile) |
|
|
86
|
+
| `clear_record.providers` | per-vendor ASR backend adapters (apple / nvidia / amd) |
|
|
87
|
+
| `clear_record.cli` | the `clear-record` command implementation |
|
|
88
|
+
|
|
89
|
+
The layers are **not** separate distributions — the subpackages hide them behind
|
|
90
|
+
one install name while the import layering (and the vendor-free core) stays
|
|
91
|
+
enforced by a test (ADR-0012, ADR-0004). The console script targets
|
|
92
|
+
`clear_record.cli:main` directly, so `import clear_record` stays light.
|
|
93
|
+
|
|
94
|
+
**Code** is [MIT](https://github.com/zhaoweny/clear-record/blob/main/LICENSE); the
|
|
95
|
+
license boundary — including how copyleft is consumed over process/network
|
|
96
|
+
boundaries — is
|
|
97
|
+
[ADR-0003](https://github.com/zhaoweny/clear-record/blob/main/docs/adr/0003-license-boundary.md).
|
|
98
|
+
See the [repository README](https://github.com/zhaoweny/clear-record#readme) for
|
|
99
|
+
the full story.
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# clear-record
|
|
2
|
+
|
|
3
|
+
**Local-first multitrack transcription and record reconstruction:** ingest several
|
|
4
|
+
recordings of one event, align them onto a common timebase, transcribe them
|
|
5
|
+
locally, and reconcile **one clear, attributed record** — *from many recordings to
|
|
6
|
+
one clear record*.
|
|
7
|
+
|
|
8
|
+
Entirely offline after a one-time model download: no cloud, no telemetry, no
|
|
9
|
+
account.
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
# from PyPI
|
|
13
|
+
uvx clear-record --help # run it without installing
|
|
14
|
+
uv tool install clear-record # or: pipx install clear-record
|
|
15
|
+
|
|
16
|
+
# from a source checkout
|
|
17
|
+
uv sync --all-packages --extra apple
|
|
18
|
+
uv run --all-packages --extra apple clear-record --help
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## The pipeline
|
|
22
|
+
|
|
23
|
+
One subcommand per stage; `run` chains them:
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
clear-record ingest # discover/declare the audio sources
|
|
27
|
+
clear-record align # place every source on a common clock (cross-correlation)
|
|
28
|
+
clear-record transcribe # run a local ASR backend (apple / nvidia / amd)
|
|
29
|
+
clear-record reconcile # merge into one attributed, aligned timeline
|
|
30
|
+
clear-record export # Markdown / SRT / VTT / JSON
|
|
31
|
+
clear-record run # ingest -> align -> transcribe -> reconcile -> export
|
|
32
|
+
clear-record calibrate # run it and report transcript quality against a reference
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Backends
|
|
36
|
+
|
|
37
|
+
All three drive the **system `whisper-cli`** plus a ggml plugin, so the default
|
|
38
|
+
install depends only on `numpy` and `soundfile` and never pulls a GPU framework;
|
|
39
|
+
the `apple` / `nvidia` / `amd` extras are **no-op markers** (ADR-0005).
|
|
40
|
+
`clear-record backends` reports what the current machine can actually run.
|
|
41
|
+
|
|
42
|
+
## How it is packaged
|
|
43
|
+
|
|
44
|
+
`clear-record` is a **single published distribution**: one import package,
|
|
45
|
+
`clear_record`, with four internal layers as subpackages —
|
|
46
|
+
|
|
47
|
+
| Layer | Contents |
|
|
48
|
+
|---|---|
|
|
49
|
+
| `clear_record.core` | backend-agnostic domain model (no third-party deps) |
|
|
50
|
+
| `clear_record.engine` | audio I/O, cross-correlation alignment, reconcile (numpy + soundfile) |
|
|
51
|
+
| `clear_record.providers` | per-vendor ASR backend adapters (apple / nvidia / amd) |
|
|
52
|
+
| `clear_record.cli` | the `clear-record` command implementation |
|
|
53
|
+
|
|
54
|
+
The layers are **not** separate distributions — the subpackages hide them behind
|
|
55
|
+
one install name while the import layering (and the vendor-free core) stays
|
|
56
|
+
enforced by a test (ADR-0012, ADR-0004). The console script targets
|
|
57
|
+
`clear_record.cli:main` directly, so `import clear_record` stays light.
|
|
58
|
+
|
|
59
|
+
**Code** is [MIT](https://github.com/zhaoweny/clear-record/blob/main/LICENSE); the
|
|
60
|
+
license boundary — including how copyleft is consumed over process/network
|
|
61
|
+
boundaries — is
|
|
62
|
+
[ADR-0003](https://github.com/zhaoweny/clear-record/blob/main/docs/adr/0003-license-boundary.md).
|
|
63
|
+
See the [repository README](https://github.com/zhaoweny/clear-record#readme) for
|
|
64
|
+
the full story.
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["uv_build>=0.12.0,<0.13.0"]
|
|
3
|
+
build-backend = "uv_build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "clear-record"
|
|
7
|
+
version = "0.1.1"
|
|
8
|
+
description = "Local-first multitrack transcription and record reconstruction: from many recordings to one clear record."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = "MIT"
|
|
11
|
+
license-files = ["LICENSE"]
|
|
12
|
+
keywords = [
|
|
13
|
+
"cli",
|
|
14
|
+
"transcription",
|
|
15
|
+
"audio",
|
|
16
|
+
"speech-to-text",
|
|
17
|
+
"asr",
|
|
18
|
+
"pipeline",
|
|
19
|
+
"reconciliation",
|
|
20
|
+
"signal-processing",
|
|
21
|
+
"alignment",
|
|
22
|
+
"whisper",
|
|
23
|
+
"cuda",
|
|
24
|
+
"rocm",
|
|
25
|
+
"metal",
|
|
26
|
+
"backend",
|
|
27
|
+
]
|
|
28
|
+
classifiers = [
|
|
29
|
+
"Development Status :: 4 - Beta",
|
|
30
|
+
"Intended Audience :: Developers",
|
|
31
|
+
"Operating System :: OS Independent",
|
|
32
|
+
"Programming Language :: Python :: 3",
|
|
33
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
34
|
+
"Programming Language :: Python :: 3.12",
|
|
35
|
+
"Topic :: Multimedia :: Sound/Audio :: Speech",
|
|
36
|
+
"Topic :: Multimedia :: Sound/Audio :: Analysis",
|
|
37
|
+
"Topic :: Scientific/Engineering",
|
|
38
|
+
"Topic :: Scientific/Engineering :: Artificial Intelligence",
|
|
39
|
+
"Topic :: Software Development :: Libraries :: Python Modules",
|
|
40
|
+
"Topic :: Text Processing",
|
|
41
|
+
"Environment :: Console",
|
|
42
|
+
"Topic :: Utilities",
|
|
43
|
+
]
|
|
44
|
+
requires-python = ">=3.12"
|
|
45
|
+
dependencies = [
|
|
46
|
+
"numpy>=2.0",
|
|
47
|
+
"soundfile>=0.12",
|
|
48
|
+
]
|
|
49
|
+
|
|
50
|
+
[[project.authors]]
|
|
51
|
+
name = "zhaoweny"
|
|
52
|
+
email = "zhaoweny@users.noreply.github.com"
|
|
53
|
+
|
|
54
|
+
[project.urls]
|
|
55
|
+
Homepage = "https://github.com/zhaoweny/clear-record"
|
|
56
|
+
Repository = "https://github.com/zhaoweny/clear-record"
|
|
57
|
+
Issues = "https://github.com/zhaoweny/clear-record/issues"
|
|
58
|
+
|
|
59
|
+
[project.optional-dependencies]
|
|
60
|
+
apple = []
|
|
61
|
+
nvidia = []
|
|
62
|
+
amd = []
|
|
63
|
+
all = []
|
|
64
|
+
|
|
65
|
+
[project.scripts]
|
|
66
|
+
clear-record = "clear_record.cli:main"
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["uv_build>=0.12.0,<0.13.0"]
|
|
3
|
+
build-backend = "uv_build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "clear-record"
|
|
7
|
+
version = "0.1.1"
|
|
8
|
+
description = "Local-first multitrack transcription and record reconstruction: from many recordings to one clear record."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = "MIT"
|
|
11
|
+
license-files = ["LICENSE"]
|
|
12
|
+
authors = [{ name = "zhaoweny", email = "zhaoweny@users.noreply.github.com" }]
|
|
13
|
+
keywords = [
|
|
14
|
+
"cli",
|
|
15
|
+
"transcription",
|
|
16
|
+
"audio",
|
|
17
|
+
"speech-to-text",
|
|
18
|
+
"asr",
|
|
19
|
+
"pipeline",
|
|
20
|
+
"reconciliation",
|
|
21
|
+
"signal-processing",
|
|
22
|
+
"alignment",
|
|
23
|
+
"whisper",
|
|
24
|
+
"cuda",
|
|
25
|
+
"rocm",
|
|
26
|
+
"metal",
|
|
27
|
+
"backend",
|
|
28
|
+
]
|
|
29
|
+
classifiers = [
|
|
30
|
+
"Development Status :: 4 - Beta",
|
|
31
|
+
"Intended Audience :: Developers",
|
|
32
|
+
"Operating System :: OS Independent",
|
|
33
|
+
"Programming Language :: Python :: 3",
|
|
34
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
35
|
+
"Programming Language :: Python :: 3.12",
|
|
36
|
+
"Topic :: Multimedia :: Sound/Audio :: Speech",
|
|
37
|
+
"Topic :: Multimedia :: Sound/Audio :: Analysis",
|
|
38
|
+
"Topic :: Scientific/Engineering",
|
|
39
|
+
"Topic :: Scientific/Engineering :: Artificial Intelligence",
|
|
40
|
+
"Topic :: Software Development :: Libraries :: Python Modules",
|
|
41
|
+
"Topic :: Text Processing",
|
|
42
|
+
"Environment :: Console",
|
|
43
|
+
"Topic :: Utilities",
|
|
44
|
+
]
|
|
45
|
+
requires-python = ">=3.12"
|
|
46
|
+
dependencies = [
|
|
47
|
+
"numpy>=2.0",
|
|
48
|
+
"soundfile>=0.12",
|
|
49
|
+
]
|
|
50
|
+
|
|
51
|
+
[project.urls]
|
|
52
|
+
Homepage = "https://github.com/zhaoweny/clear-record"
|
|
53
|
+
Repository = "https://github.com/zhaoweny/clear-record"
|
|
54
|
+
Issues = "https://github.com/zhaoweny/clear-record/issues"
|
|
55
|
+
|
|
56
|
+
# Backend extras are no-op markers (every path uses the system `whisper-cli` +
|
|
57
|
+
# a ggml plugin); they exist so `--extra <backend>` stays a valid switch. See
|
|
58
|
+
# ADR-0005.
|
|
59
|
+
[project.optional-dependencies]
|
|
60
|
+
apple = []
|
|
61
|
+
nvidia = []
|
|
62
|
+
amd = []
|
|
63
|
+
all = []
|
|
64
|
+
|
|
65
|
+
[project.scripts]
|
|
66
|
+
clear-record = "clear_record.cli:main"
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"""clear-record: a local-first multitrack transcription and record-reconstruction tool.
|
|
2
|
+
|
|
3
|
+
The published distribution is a single package with four internal layers:
|
|
4
|
+
|
|
5
|
+
- :mod:`clear_record.core` — backend-agnostic domain model (no third-party deps);
|
|
6
|
+
- :mod:`clear_record.engine` — audio I/O, alignment, reconcile (numpy/soundfile);
|
|
7
|
+
- :mod:`clear_record.providers` — per-vendor ASR backend adapters;
|
|
8
|
+
- :mod:`clear_record.cli` — the ``clear-record`` command implementation.
|
|
9
|
+
|
|
10
|
+
This module is deliberately light (a docstring only) so that importing
|
|
11
|
+
``clear_record`` does not pull in the heavy CLI or audio stack. The console
|
|
12
|
+
script targets :func:`clear_record.cli.main` directly.
|
|
13
|
+
"""
|
|
14
|
+
|
|
15
|
+
__all__: list[str] = []
|