TranscribeTools 0.5.5__py2.py3-none-any.whl

transcribetools/__init__.py

@@ -0,0 +1,5 @@
+from .transcribe_folder import process_file, cli
+
+__all__ = ["process_file", "cli"]
+
+__version__ = "0.5.4"  # It MUST match the version in pyproject.toml file

transcribetools/commandline.py

@@ -0,0 +1,5 @@
+from transcribetools.transcribe_folder import cli
+
+if __name__ == '__main__':
+    cli()
+    # console = rich.console.Console(width=120, force_terminal=True)

transcribetools/config.toml

@@ -0,0 +1,2 @@
+folder = "/Users/ncdegroot/Library/CloudStorage/OneDrive-Gedeeldebibliotheken-TilburgUniversity/Project - Reflective cafe - data"
+model = "large"

transcribetools/local_whisper.py

@@ -0,0 +1,185 @@
+from datetime import datetime
+import logging
+from pathlib import Path
+import tkinter as tk
+from tkinter.filedialog import askdirectory
+# from tkinter import messagebox as mb
+import pymsgbox as msgbox
+import toml
+import whisper
+import rich
+from rich.prompt import Prompt
+import rich_click as click
+from result import Result, is_ok, is_err, Ok, Err
+from .local_wisper_model import save_config_to_toml, get_config_from_toml, ask_choice, show_config, console
+
+# logging.getLogger("python3").setLevel(logging.ERROR)
+# loggers = [logging.getLogger(name) for name in logging.root.manager.loggerDict]
+# tk bug in sequoia
+# import sys
+# sys.stderr = open("log", "w", buffering=1)
+# can't find the 'python3' logger to silence
+
+MODEL = "large"
+# LOCALPATH = ('/Users/ncdegroot/Library/CloudStorage/'
+#              'OneDrive-Gedeeldebibliotheken-TilburgUniversity/'
+#              'Project - Reflective cafe - data')
+LOCALPATH = Path.cwd()
+model = None
+
+
+def process_file(path):
+    output_path = path.with_suffix('.txt')
+    try:
+        print("Start processing...")
+        result = model.transcribe(str(path), verbose=True)
+        # false: only progressbar; true: all; no param: no feedback
+    except Exception as e:
+        print(f"Error while processing {path}: '{e}'. Please fix it")
+    else:
+        text_to_save = result["text"]
+        print(text_to_save)
+
+        # file_name = f"{data_file.split('.')[0]}_{datetime.now().strftime('%Y-%m-%d-%H-%M-%S')}.txt"
+        # file_name = output_path
+        # Open the file in write mode
+        with open(output_path, 'w') as file:
+            # Write the text to the file
+            file.write(text_to_save)
+
+        print(f'Text has been saved to {output_path}')
+
+
+@click.group(no_args_is_help=True,
+             epilog='Check out the docs at https://gitlab.uvt.nl/tst-research/transcribetools for more details')
+@click.version_option(package_name='transcribetools')
+@click.pass_context  # our 'global' context
+@click.option("--configfilename",
+              default="localwhisper.toml",
+              help="Specify config file to use",
+              show_default=True,
+              metavar="FILE",
+              type=click.Path(exists=True, dir_okay=False, readable=True, resolve_path=True),
+              show_choices=False,
+              required=False,
+              prompt="Enter config filename",
+              )
+def cli(ctx: click.Context, configfilename):
+    global model
+    # open config, ask for values if needed:
+    #  Prompt.ask(msg)
+    home = Path.home()
+    config_path = home / configfilename
+    if not config_path.exists():
+        save_config_to_toml(config_path, LOCALPATH, MODEL)
+    result = get_config_from_toml(config_path)
+    if is_err(result):
+        click.echo(f"Exiting due to {result.err}")
+        exit(1)
+    config = result.ok_value
+    if config:
+        # click.echo("Config")
+        click.echo(f"Config filename: {config_path}")
+        # click.echo(f"Folder path for soundfiles: {config.folder}")
+        # click.echo(f"Transcription model name: {config.model}")
+
+    ctx.obj = config
+    # process_files(config)
+
+
+# the `cli` subcommand 'process'
+
+@cli.command("process", help="Using current configuration, transcribe all soundfiles in the folder")
+# @click.option("--filename",
+#               default="localwhisper.toml",
+#               help="Specify config file to use",
+#               show_default=True,
+#               metavar="FILE",
+#               type=click.Path(exists=True, dir_okay=False, readable=True, resolve_path=True),
+#               show_choices=False,
+#               required=False,
+#               prompt="Enter config file name",
+#               )
+@click.pass_obj  # in casu the config obj
+def process(config):
+    global model
+    # config = config
+    model = whisper.load_model(config.model)
+    soundfiles_path = Path(config.folder)
+    txt_files = [file for file in soundfiles_path.glob('*') if file.suffix.lower() == '.txt']
+    file_stems = [file.stem for file in txt_files]
+    # a txt file_stem indicates mp3 has been processed already
+    mp3_files = [file for file in soundfiles_path.glob('*') if file.suffix.lower() == '.mp3' and
+                 file.stem not in file_stems]
+    click.echo(f"{len(mp3_files)} files to be processed")
+    for file in mp3_files:
+        click.echo(f"Processing {file}")
+        process_file(file)
+
+
+# the `cli` command config
+@cli.group("config")
+def config():
+    pass
+
+
+# the `config` create subcommand
+@click.command("create", help="Create new configuration file")
+def create():
+    msg = "Select folder to monitor containing the sound files"
+    click.echo(msg)
+    # root = tk.Tk()
+    # root.focus_force()
+    # Cause the root window to disappear milliseconds after calling the filedialog.
+    # root.after(100, root.withdraw)
+    # tk.Tk().withdraw()
+    # hangs: mb.showinfo("msg","Select folder containing the sound files")
+    msgbox.alert(msg, "info")
+    # "title" only supported on linux ith wv ...
+    folder = askdirectory(title="Select folder to monitor containing the sound files",
+                          mustexist=True,
+                          initialdir='~')
+    choices = ["tiny", "base", "small", "medium", "large"]
+    # inx = ask_choice("Choose a model", choices)
+    # model = choices[inx]
+    model = Prompt.ask("Choose a model",
+                       console=console,
+                       choices=choices,
+                       show_default=True,
+                       default="large")
+    config_name = Prompt.ask("Enter a name for the configuration file",
+                             show_default=True,
+                             default="localwhisper.toml")
+    config_path = Path(config_name)
+    toml_path = config_path.with_suffix(".toml")
+    while toml_path.exists():  # current dir
+        result = get_config_from_toml(toml_path)
+        click.secho("Already exists...", fg='red')
+        show_config(result)
+        overwrite = Prompt.ask("Overwrite?",
+                               choices=["y", "n"],
+                               default="n",
+                               show_default=True)
+        if overwrite == "y":
+            break
+        else:
+            return
+    # Prompt.ask("Enter model name")
+    save_config_to_toml(toml_path, folder, model)
+    click.echo(f"{toml_path} saved")
+
+
+# the 'config' show subcommand
+@click.command("show", help="Show current configuration file")
+@click.pass_obj
+def show(config):
+    click.echo(f"Config folder path: {config.folder}")
+    click.echo(f"Config model name: {config.model}")
+
+
+# connect the subcommand to `config'
+config.add_command(create)
+config.add_command(show)
+
+if __name__ == "__main__":
+    cli()

transcribetools/local_wisper_model.py

@@ -0,0 +1,73 @@
+import toml
+from result import is_ok, is_err, Ok, Err, Result
+from attrs import define
+from rich.console import Console
+
+console = Console(width=120, force_terminal=True)
+
+
+@define
+class Config:
+    folder: str
+    model: str
+
+
+def save_config_to_toml(filepath,
+                        folder_name="",
+                        model_name=""):
+    try:
+        data = {"folder": folder_name, "model": model_name}
+        with open(filepath, 'w') as toml_file:
+            # noinspection PyTypeChecker
+            toml.dump(data, toml_file)
+    except Exception as e:
+        print(f"Error saving config to TOML file: {e}")
+
+
+def get_config_from_toml(filepath) -> Result:
+    try:
+        with open(filepath, 'r') as toml_file:
+            data = toml.load(toml_file)
+    except FileNotFoundError:
+        Err("TOML file not found.")
+    except toml.TomlDecodeError:
+        Err("Error decoding TOML file.")
+    except Exception as e:
+        Err(f"Unexpected error: {e}")
+    else:
+        config = Config(**data)  # as data is flat, it's ok
+        return Ok(config)
+
+
+def ask_choice(msg: str, choices) -> int:
+
+    # Print het keuzemenu
+    console.print(
+            f"[bold magenta]{msg}[/bold magenta]\n"
+            "[yellow]Kies een van de volgende opties:[/yellow]"
+    )
+    for i, choice in enumerate(choices, start=1):
+        console.print(f"{i}. {choice}")
+
+    # Vraag input van de gebruiker
+    user_input = Prompt.ask(
+        "Voer het nummer van je keuze in",
+        choices=[str(i) for i in range(1, len(choices) + 1)]
+    )
+
+    # Verwerk de keuze
+    chosen_option = choices[int(user_input) - 1]  # Converteer input naar index
+    console.print(f"[green]Je hebt gekozen voor:[/green] {chosen_option}")
+
+    return chosen_option
+
+
+def show_config(result: Result):
+    if is_err(result):
+        print(f"Exiting due to {result.err}")
+        return False
+    config = result.ok_value
+    if config:
+        print(f"Config folder path: {config.folder}")
+        print(f"Config model name: {config.model}")
+    return True

transcribetools/transcribe_folder.py

@@ -0,0 +1,423 @@
+import time
+from pathlib import Path
+
+# import tkinter as tk
+from tkinter.filedialog import askdirectory
+
+# from tkinter import messagebox as mb
+import pymsgbox as msgbox
+
+# import toml
+import whisper
+
+# import rich
+from rich.prompt import Prompt
+import rich_click as click
+from result import Result, is_ok, is_err, Ok, Err  # noqa: F401
+import soundfile as sf
+
+from .transcribe_folder_model import (
+    save_config_to_toml,
+    get_config_from_toml,
+    show_config,
+    console,
+)
+
+# logging.getLogger("python3").setLevel(logging.ERROR)
+# loggers = [logging.getLogger(name) for name in logging.root.manager.loggerDict]
+# tk bug in sequoia
+# import sys
+# sys.stderr = open("log", "w", buffering=1)
+# can't find the 'python3' logger to silence
+
+MODEL = "large"
+# LOCALPATH = ('/Users/ncdegroot/Library/CloudStorage/'
+#              'OneDrive-Gedeeldebibliotheken-TilburgUniversity/'
+#              'Project - Reflective cafe - data')
+LOCALPATH = Path.cwd()
+model = None
+
+
+def process_file(path, args):
+    """open file, transcribe using args and save to file"""
+    output_path = path.with_suffix(".txt")
+    try:
+        click.echo("Start processing...")
+        result = model.transcribe(
+            str(path),
+            verbose=True,
+            **args,
+        )
+        # false: only progressbar; true: all; no param: no feedback
+    except Exception as e:
+        click.echo(f"Error while processing {path}: '{e}'. Please fix it")
+    else:
+        text_to_save = result["text"]
+        click.echo(text_to_save)
+
+        # file_name = f"{data_file.split('.')[0]}_{datetime.now().strftime('%Y-%m-%d-%H-%M-%S')}.txt"
+        # file_name = output_path
+        # Open the file in write mode
+        with open(output_path, "w") as file:
+            # Write the text to the file
+            file.write(text_to_save)
+
+        click.echo(f"Text has been saved to {output_path}")
+
+
+def translate_it(input_path: Path, translator, args):
+    """open the file on this path, translate using args and save to file"""
+    output_path = input_path.with_stem(
+        str(input_path.stem).replace(args["source_lang"], args["target_lang"])
+    )
+    # else
+    if args["target_lang"] not in input_path.stem:
+        output_path = input_path.with_stem(input_path.stem + "-" + args["target_lang"])
+
+    # if doc(x) or other formatted files
+    if input_path.suffix != ".txt":
+        # Using translate_document_from_filepath() with file paths
+        translator.translate_document_from_filepath(
+            input_path, output_path, **args
+        )
+    else:  # txt
+        with open(input_path, "r", encoding="utf-8") as infile:
+
+            try:
+                click.echo("Start translating...")
+                result = translator.translate_text(
+                    text=infile.read(),
+                    **args,
+                )
+                # false: only progressbar; true: all; no param: no feedback
+            except Exception as e:
+                click.echo(f"Error while processing {input_path}: '{e}'. Please fix it")
+            else:
+                text_to_save = result.text
+                click.echo(text_to_save)
+
+                # file_name = f"{data_file.split('.')[0]}_{datetime.now().strftime('%Y-%m-%d-%H-%M-%S')}.txt"
+                # file_name = output_path
+                # Open the file in write mode
+                #
+                # existing replace
+
+                with open(output_path, "w") as outfile:
+                    # Write the text to the file
+                    outfile.write(text_to_save)
+
+                    click.echo(f"Text has been saved to {output_path}")
+
+
+@click.group(
+    no_args_is_help=True,
+    epilog="Use config --help or process --help to see options.\n"
+    "Check out the docs at https://gitlab.uvt.nl/tst-research/transcribetools "
+    "for more details",
+)
+@click.version_option(package_name="transcribetools")
+@click.option(
+    "--debug/--no-debug",
+    "-d/-n",
+    help="Print debug messages and timing information",
+    default=False,
+)
+@click.pass_context  # our 'global' context
+@click.option(
+    "--configfilename",
+    "-c",
+    default=Path.home() / "localwhisper.toml",
+    help="Specify config file to use",
+    # show_default=True,
+    metavar="FILE",
+    type=click.Path(exists=True, dir_okay=False, readable=True, resolve_path=True),
+    show_choices=False,
+    required=False,
+    # prompt="Enter new config filename or accept default",
+)
+def cli(ctx: click.Context, debug, configfilename):
+    global model
+    # open config, ask for values if needed:
+    #  Prompt.ask(msg)
+    home = Path.home()
+    config_path = home / configfilename
+    if debug:
+        click.echo(f"Config_path: {config_path}")
+    if not config_path.exists():
+        save_config_to_toml(config_path, LOCALPATH, MODEL)
+    result = get_config_from_toml(
+        config_path
+    )  # has the default values (homedir, large)
+    if is_err(result):
+        click.echo(f"Exiting due to {result.err}")
+        exit(1)
+    config = result.ok_value
+    if config:
+        # click.echo("Config")
+        click.echo(f"Config filename: {config_path}")
+        # click.echo(f"Folder path for soundfiles: {config.folder}")
+        # click.echo(f"Transcription model name: {config.model}")
+    config.debug = debug
+    ctx.obj = config
+    # process_files(config)
+
+
+# the `cli` subcommand 'process'
+
+
+@cli.command(
+    "transcribe",
+    help="Using current configuration, transcribe all soundfiles in the folder",
+)
+@click.option(
+    "--language",
+    "-l",
+    default="AUTO",
+    type=click.Choice(
+        ["nl", "en", "AUTO"],
+        case_sensitive=False,
+    ),
+)
+@click.option(
+    "--select_folder",
+    "-s",
+    default=False,
+    flag_value=True,
+    help="Override the path to the soundfiles from config, select a folder",
+)
+@click.option(
+    "--prompt",
+    "-p",
+    help='-p "" You can add special prompts and words (spelling) (max 224 chars) see '
+    "https://cookbook.openai.com/examples/whisper_prompting_guide",
+)
+@click.pass_obj  # in casu the config obj
+def transcribe(config, select_folder, prompt, language):
+    global model
+    # config = config
+    if config.debug:
+        click.echo(f"Load model: {config.model}")
+    model = whisper.load_model(config.model)
+    soundfiles_path = Path(config.folder)
+    if config.debug:
+        click.echo(f"Folder path for soundfiles: {soundfiles_path}")
+        click.echo(f"{language=}, {prompt=} ")
+
+    if select_folder:
+        soundfiles_path = Path(
+            askdirectory(
+                title="Select folder containing the sound files",
+                mustexist=True,
+                initialdir="~",
+            )
+        )
+
+    txt_files = [
+        file for file in soundfiles_path.glob("*") if file.suffix.lower() == ".txt"
+    ]
+    file_stems = [file.stem for file in txt_files]
+    # a txt file_stem indicates mp3 has been processed already (skip file with nio suffix
+    soundfiles = [
+        file
+        for file in soundfiles_path.glob("*")
+        if file.suffix.lower()
+        in (".mp3", "mp3", ".mp4", ".mpweg", ".mpga", ".m4a", ".wav", ".webm")
+        and file.stem not in file_stems
+    ]
+    click.echo(f"{len(soundfiles)} files to be processed")
+    duration = 0
+    start = time.perf_counter()
+
+    for file in soundfiles:
+        f, samplerate = sf.read(file)
+        duration += len(f) / samplerate
+        click.echo(f"Processing {file}")
+        args = dict()
+        if language != "AUTO":
+            args["language"] = language
+        if prompt:
+            args["prompt"] = prompt
+        process_file(file, args)
+    if soundfiles:
+        process_time = time.perf_counter() - start
+        click.echo(
+            f"Total sound duration: {duration:.1f} seconds, \n"
+            f"processing time: {process_time:.1f} seconds, \n"
+            f"realtime factor: {(process_time / duration):.2f}"
+        )
+
+
+@cli.command(
+    "deeple_translate",
+    help="Using current configuration, translate all txt/doc/docx files in the folder",
+)
+@click.option(
+    "--source_language",
+    "-sl",
+    default="NL",
+    show_default=True,
+    type=click.Choice(
+        ["NL", "EN-GB", "EN-US", "AUTO"],
+        case_sensitive=False,
+    ),
+)
+@click.option(
+    "--target_language",
+    "-tl",
+    default="EN-GB",
+    type=click.Choice(
+        ["EN-GB", "EN-US", "NL"],
+        case_sensitive=False,
+    ),
+)
+@click.option(
+    "--select_folder",
+    "-s",
+    default=False,
+    flag_value=True,
+    help="Override the path to the files from config, select a folder",
+)
+@click.option(
+    "--prompt",
+    "-p",
+    help='-p "" You can add special prompts see https://www.deepl.com/en/pro-api',
+)
+@click.pass_obj  # in casu the config obj
+def deeple_translate(config, select_folder, prompt, source_language, target_language):
+    import deepl
+    import keyring as kr
+
+    if source_language == target_language:
+        raise click.BadParameter(f"Nothing to do {source_language} -> {target_language}")
+
+    valid_choices = ["EN-GB", "EN-US", "NL"]
+
+    if target_language not in valid_choices:
+        raise click.BadParameter(f"Invalid {target_language=} should be in {valid_choices}")
+
+    service_name = "DeeplAPI"
+    key = "auth_key"
+    # time.sleep(30)
+
+    auth_key = kr.get_password(service_name=service_name, username=key)
+    if auth_key is None:
+        key = Prompt.ask("Paste your auth key here")
+        kr.set_password(service_name=service_name, username=key, password=key)
+
+    translator = deepl.Translator(auth_key)
+
+    sourcefiles_path = Path(config.folder)
+    if config.debug:
+        click.echo(f"Folder path for sourcefiles: {sourcefiles_path}")
+        click.echo(f"{source_language=} -> {target_language=}, {prompt=} ")
+
+    if select_folder:
+        sourcefiles_path = Path(
+            askdirectory(
+                title="Select folder containing the source files",
+                mustexist=True,
+                initialdir="~",
+            )
+        )
+
+    translated_files = [
+        file
+        for file in sourcefiles_path.glob("*")
+        if f"{target_language}" in file.stem and file.suffix.lower() == ".txt"
+    ]
+    file_stems = [file.stem for file in translated_files]
+    # file has been processed already (skip file with no suffix
+    translate_file_paths = [
+        file
+        for file in sourcefiles_path.glob("*")
+        if file.suffix.lower() in (".txt", ".doc", ".docx")
+        and file.stem not in file_stems
+    ]
+    # candidates heave text-like suffix and no translation yet (no file in folder with target language code
+    click.echo(f"{len(translate_file_paths)} files to be processed")
+
+    for file in translate_file_paths:
+        if "~$" in file.name:
+            click.echo(f"Skipping {file}")
+            continue
+        click.echo(f"Processing {file}")
+        args = dict()
+        args['target_lang'] = target_language
+        if source_language != "AUTO":
+            args["source_lang"] = source_language
+        if prompt:
+            args["prompt"] = prompt
+        translate_it(file, translator, args)
+
+
+# the `cli` command config
+@cli.group("config", help="configuration")
+def config():
+    pass
+
+
+# the `config` create subcommand
+@click.command("create", help="Create new configuration file")
+def create():
+    msg = "Select folder to containing the sound files"
+    click.echo(msg)
+    # root = tk.Tk()
+    # root.focus_force()
+    # Cause the root window to disappear milliseconds after calling the filedialog.
+    # root.after(100, root.withdraw)
+    # tk.Tk().withdraw()
+    # hangs: mb.showinfo("msg","Select folder containing the sound files")
+    msgbox.alert(msg, "info")
+    # "title" only supported on linux ith wv ...
+    folder = askdirectory(
+        title="Select folder to monitor containing the sound files",
+        mustexist=True,
+        initialdir="~",
+    )
+    choices = ["tiny", "base", "small", "medium", "large", "turbo"]
+    # inx = ask_choice("Choose a model", choices)
+    # model = choices[inx]
+    model = Prompt.ask(
+        "Choose a model",
+        console=console,
+        choices=choices,
+        show_default=True,
+        default="large",
+    )
+    config_name = Prompt.ask(
+        "Enter a name for the configuration file",
+        show_default=True,
+        default="localwhisper.toml",
+    )
+    config_path = Path(config_name)
+    toml_path = config_path.with_suffix(".toml")
+    while toml_path.exists():  # current dir
+        result = get_config_from_toml(toml_path)
+        click.secho("Already exists...", fg="red")
+        show_config(result)
+        overwrite = Prompt.ask(
+            "Overwrite?", choices=["y", "n"], default="n", show_default=True
+        )
+        if overwrite == "y":
+            break
+        else:
+            return
+    # Prompt.ask("Enter model name")
+    save_config_to_toml(toml_path, folder, model)
+    click.echo(f"{toml_path} saved")
+
+
+# the 'config' show subcommand
+@click.command("show", help="Show current configuration file")
+@click.pass_obj
+def show(config):
+    click.echo(f"Config folder path: {config.folder}")
+    click.echo(f"Config model name: {config.model}")
+
+
+# connect the subcommand to `config'
+config.add_command(create)
+config.add_command(show)
+
+if __name__ == "__main__":
+    cli()

transcribetools/transcribe_folder_model.py

@@ -0,0 +1,80 @@
+from typing import Union
+from pathlib import Path
+import click
+from rich.prompt import Prompt
+import toml
+from result import is_ok, is_err, Ok, Err, Result  # noqa: F401
+from attrs import define
+from rich.console import Console
+
+console = Console(width=120, force_terminal=True)
+
+
+@define
+class Config:
+    folder: str
+    model: str
+    debug: bool = False
+
+
+def save_config_to_toml(filepath,
+                        folder: Union[str, Path] = "",
+                        model_name: str = ""):
+    try:
+        # let's save a clean folder path, so we can use Path() when retrieving
+        data = {"folder": str(folder), "model": model_name}
+        with open(filepath, 'w') as toml_file:
+            # noinspection PyTypeChecker
+            toml.dump(data, toml_file)
+    except Exception as e:
+        click.secho(f"Error saving config to "
+                    f"TOML file @ {filepath}: {e}", fg='red')
+
+
+def get_config_from_toml(filepath) -> Result:
+    try:
+        with open(filepath, 'r') as toml_file:
+            data = toml.load(toml_file)
+    except FileNotFoundError:
+        return Err("TOML file not found.")
+    except toml.TomlDecodeError:
+        return Err("Error decoding TOML file.")
+    except Exception as e:
+        return Err(f"Unexpected error: {e}")
+    else:
+        config = Config(**data)  # as data is flat, it's ok
+        return Ok(config)
+
+
+def ask_choice(msg: str, choices) -> int:
+
+    # Print het keuzemenu
+    console.print(
+            f"[bold magenta]{msg}[/bold magenta]\n"
+            "[yellow]Kies een van de volgende opties:[/yellow]"
+    )
+    for i, choice in enumerate(choices, start=1):
+        console.print(f"{i}. {choice}")
+
+    # Vraag input van de gebruiker
+    user_input = Prompt.ask(
+        "Voer het nummer van je keuze in",
+        choices=[str(i) for i in range(1, len(choices) + 1)]
+    )
+
+    # Verwerk de keuze
+    chosen_option = choices[int(user_input) - 1]  # Converteer input naar index
+    console.print(f"[green]Je hebt gekozen voor:[/green] {chosen_option}")
+
+    return chosen_option
+
+
+def show_config(result: Result):
+    if is_err(result):
+        click.echo(f"Exiting due to {result.err}")
+        return False
+    config = result.ok_value
+    if config:
+        click.echo(f"Config folder path: {config.folder}")
+        click.echo(f"Config model name: {config.model}")
+    return True

transcribetools-0.5.5.dist-info/METADATA

@@ -0,0 +1,80 @@
+Metadata-Version: 2.4
+Name: TranscribeTools
+Version: 0.5.5
+Summary: Transcribe all soundfiles in a folder using Whisper
+License-File: LICENSE
+License-File: LICENSE-2.0.txt
+Requires-Dist: attrs>=24.2.0
+Requires-Dist: openai-whisper>=20240930
+Requires-Dist: openai>=1.59.4
+Requires-Dist: pymsgbox>=1.0.9
+Requires-Dist: result>=0.17.0
+Requires-Dist: rich-click>=1.8.5
+Requires-Dist: soundfile>=0.13.0
+Requires-Dist: tiutools>=0.4.1
+Requires-Dist: toml>=0.10.2
+Requires-Dist: transformers>=4.49.0
+Description-Content-Type: text/markdown
+
+# LocalWhisper
+
+## Introduction
+TranscribeTools is an Python application which transcribes all 
+sound files in a configurable folder using a local Whisper model. 
+TranscribeTools contains an Python application LocalWhisper
+which transcribes all sound files in a configurable folder using a local Whisper model. 
+You can choose which Whisper model is to be used 
+
+## Details
+ - using Python 3.12.7, openai-whisper https://pypi.org/project/openai-whisper/ (current version 20240930) 
+does not support 3.13 yet.
+
+## License
+This project is licensed under the Apache 2.0 License - see the [LICENSE file](LICENSE) for details.
+
+## Setup
+We use uv for managing virtual environments and package installation. Follow these steps to set up the project:
+
+### On macOS:
+#### Install uv
+- First install brew if needed from https://github.com/Homebrew/brew/releases/latese
+
+### On Windows:
+#### Download the setup script
+We need to install `UV` a tool to install the Python environment and to 
+install the tool. There are a few possibilities
+
+1. Follow instructions at  [the UV website](https://docs.astral.sh/uv/getting-started/installation/#__tabbed_1_2)
+
+2. Press {Windows button} then type or paste:. 
+```powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"```
+
+3. Use `winget`
+- Open the Windows Powershell: press {Windows} button and type or paste
+```Powershell
+winget install --id=astral-sh.uv  -e
+```
+
+### These scripts will:
+
+Installs the `uv` tool. Check if `uv {enter}` works. [At the moment](https://github.com/astral-sh/uv/issues/10014) a reboot is needed on Windows.
+Now we can install the tools.
+
+### Install tools
+
+```uv tool install transcribetools```
+
+Install the (commandline) tools in this project. For now 
+it's only `transcribe_folder`.
+
+## Plans
+- Make it a local service, running in the background
+- Investigate options to let it run on a central computer, as a service
+- Create Docker image
+- Add speaker partitioning (see TranscribeWhisperX)
+- Adjust models using PyTorch (more control)
+
+## Documentation about Whisper on the cloud and local
+- [Courtesy of and Credits to OpenAI: Whisper.ai](https://github.com/openai/whisper/blob/main/README.md)
+- [doc](https://pypi.org/project/openai-whisper/)
+- [alternatief model transcribe and translate](https://huggingface.co/facebook/seamless-m4t-v2-large)

transcribetools-0.5.5.dist-info/RECORD

@@ -0,0 +1,13 @@
+transcribetools/__init__.py,sha256=0cQb9ynDzYaDSNCTalMwK8u4BZajF_b8-9R59OQCHWY,159
+transcribetools/commandline.py,sha256=JqsmXy7SZwQ_clZiU67Ixv8TE0ylHr6CyoeKFc5awKk,157
+transcribetools/config.toml,sha256=gqbWdxviZn34UqAk1CzE-zRsP8j3j8KTal1o6nEdz1Q,146
+transcribetools/local_whisper.py,sha256=pYkgYwLUlYZNJMUh3-5dO46OgRXRiVZKkiblCs4ESFo,6680
+transcribetools/local_wisper_model.py,sha256=5EpGhQRnovvvlvQ9JrttxHd_bWUrq0fiQ29o1ITNYnU,2039
+transcribetools/transcribe_folder.py,sha256=JZkXp0XAWDC7ohGypLeOcunL3z1idAj16mG0Di_jKok,13208
+transcribetools/transcribe_folder_model.py,sha256=f33TjphqBeF4oMaBh92SPH_Q-v-tbQbpKez-7zku3Rg,2361
+transcribetools-0.5.5.dist-info/METADATA,sha256=eV16OqI4kS6Iiy6EmRcZkOLfq6XL6LCkH9Q5GE93OSE,2875
+transcribetools-0.5.5.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
+transcribetools-0.5.5.dist-info/entry_points.txt,sha256=gpsp8wfXw5oLExXuyXBP0BzEYxUBh4iGHiGLrp7aXug,75
+transcribetools-0.5.5.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+transcribetools-0.5.5.dist-info/licenses/LICENSE-2.0.txt,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+transcribetools-0.5.5.dist-info/RECORD,,

transcribetools-0.5.5.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any

transcribetools-0.5.5.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+transcribefolder = transcribetools.transcribe_folder:cli

transcribetools-0.5.5.dist-info/licenses/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.

transcribetools-0.5.5.dist-info/licenses/LICENSE-2.0.txt

@@ -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.