audiosub 0.1.0__tar.gz

audiosub-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: "Publish"
+
+on:
+  push:
+    tags:
+      # Publish on any tag starting with a `v`, e.g., v0.1.0
+      - v*
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Install Python 3.12
+        run: uv python install 3.12
+      - name: Build
+        run: uv build
+      # Check that basic features work and we didn't miss to include crucial files
+      - name: Smoke test (wheel)
+        run: uv run --isolated --no-project --with dist/*.whl python tests/smoke_test.py
+      - name: Smoke test (source distribution)
+        run: uv run --isolated --no-project --with dist/*.tar.gz python tests/smoke_test.py
+      - name: Publish
+        run: uv publish

audiosub-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# Agent configuration
+.iflow/

audiosub-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

audiosub-0.1.0/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: audiosub
+Version: 0.1.0
+Summary: A command-line tool for generating subtitles from audio file using mlx-whisper
+Project-URL: Homepage, https://github.com/huccihuang/audiosub
+Project-URL: Repository, https://github.com/huccihuang/audiosub
+Requires-Python: >=3.12
+Requires-Dist: click>=8.3.0
+Requires-Dist: mlx-whisper>=0.4.3
+Description-Content-Type: text/markdown
+
+# audiosub
+
+一个基于 mlx-whisper 的命令行工具，用于将音频文件转换为字幕文件。
+
+## 特点
+
+- **资源占用小**：基于 mlx-whisper，专为 Apple Silicon 优化
+- **转换速度快**：利用 Apple Metal 加速，处理速度快
+- **准确度高**：使用 OpenAI Whisper 模型，支持多种语言
+- **使用简单**：命令行操作，一键生成字幕文件
+
+## Prerequisites
+
+- Python 3.12+
+- macOS
+- uv
+
+## 使用方法
+
+通过 uv 的 `uvx` 命令安装并使用。
+
+```bash
+uvx asub audio.mp3
+# 将在当前目录生成 audio.srt 字幕文件
+```
+
+## 注意事项
+
+- **仅支持 macOS**：由于使用了 mlx 库，本工具仅能在 macOS 系统上运行
+- **Apple Silicon 优化**：在 Apple Silicon (M1/M2/M3) 芯片上性能最佳
+- **支持的音频格式**：支持常见的音频格式，如 MP3、WAV、M4A 等
+- **首次运行**：首次使用时会自动下载 Whisper 模型，请确保网络连接正常
+
+## 依赖
+
+- Python 3.12+
+- mlx-whisper
+- click
+
+## 许可证
+
+MIT

audiosub-0.1.0/README.md

@@ -0,0 +1,42 @@
+# audiosub
+
+一个基于 mlx-whisper 的命令行工具，用于将音频文件转换为字幕文件。
+
+## 特点
+
+- **资源占用小**：基于 mlx-whisper，专为 Apple Silicon 优化
+- **转换速度快**：利用 Apple Metal 加速，处理速度快
+- **准确度高**：使用 OpenAI Whisper 模型，支持多种语言
+- **使用简单**：命令行操作，一键生成字幕文件
+
+## Prerequisites
+
+- Python 3.12+
+- macOS
+- uv
+
+## 使用方法
+
+通过 uv 的 `uvx` 命令安装并使用。
+
+```bash
+uvx asub audio.mp3
+# 将在当前目录生成 audio.srt 字幕文件
+```
+
+## 注意事项
+
+- **仅支持 macOS**：由于使用了 mlx 库，本工具仅能在 macOS 系统上运行
+- **Apple Silicon 优化**：在 Apple Silicon (M1/M2/M3) 芯片上性能最佳
+- **支持的音频格式**：支持常见的音频格式，如 MP3、WAV、M4A 等
+- **首次运行**：首次使用时会自动下载 Whisper 模型，请确保网络连接正常
+
+## 依赖
+
+- Python 3.12+
+- mlx-whisper
+- click
+
+## 许可证
+
+MIT

audiosub-0.1.0/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "audiosub"
+version = "0.1.0"
+description = "A command-line tool for generating subtitles from audio file using mlx-whisper"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "click>=8.3.0",
+    "mlx-whisper>=0.4.3",
+]
+
+[project.scripts]
+asub = "audiosub:main"
+
+[project.urls]
+Homepage = "https://github.com/huccihuang/audiosub"
+Repository = "https://github.com/huccihuang/audiosub"

audiosub-0.1.0/src/audiosub/__init__.py

@@ -0,0 +1,69 @@
+import os
+import click
+import mlx_whisper
+
+
+def format_time(time):
+    '''将float格式的时间转换为字幕要求的格式 hh:mm:ss,ms'''
+    hours = int(time // 3600)
+    minutes = int((time % 3600) // 60)
+    seconds = int(time % 60)
+    milliseconds = int((time - int(time)) * 1000)
+    return f"{hours:02d}:{minutes:02d}:{seconds:02d},{milliseconds:03d}"
+
+
+def audio_to_subtitle(audio_file_path, output_file_path):
+    '''将音频文件转换为字幕文件'''
+
+    # 获取词级时间戳
+    result = mlx_whisper.transcribe(
+        audio_file_path,
+        word_timestamps=True
+    )
+
+    # 存放到文件中
+    with open(output_file_path, "w") as f:
+        for idx, segment in enumerate(result["segments"]):
+            start_time = format_time(segment["start"])
+            end_time = format_time(segment["end"])
+            f.write(
+                f"{idx + 1}\n"
+                f"{start_time} --> {end_time}\n"
+                f"{segment['text']}\n\n"
+            )
+
+
+@click.command()
+@click.argument('audio_file', type=click.Path(exists=True))
+def main(audio_file):
+    """将音频文件转换为字幕文件
+
+    使用示例：
+        mksub audio.mp3
+
+    将在当前目录生成 audio.srt 字幕文件
+    """
+    # 检查文件是否存在
+    if not os.path.exists(audio_file):
+        click.echo(f"错误：文件 '{audio_file}' 不存在", err=True)
+        return
+
+    # 获取输入文件的基本名称（不含扩展名）
+    base_name = os.path.splitext(os.path.basename(audio_file))[0]
+
+    # 在当前工作目录生成输出文件
+    output_file = f"{base_name}.srt"
+
+    click.echo(f"正在处理音频文件: {audio_file}")
+    click.echo(f"输出字幕文件: {output_file}")
+
+    try:
+        audio_to_subtitle(audio_file, output_file)
+        click.echo(f"✓ 字幕文件已生成: {output_file}")
+    except Exception as e:
+        click.echo(f"错误：处理失败 - {str(e)}", err=True)
+        raise
+
+
+if __name__ == "__main__":
+    main()

audiosub-0.1.0/tests/smoke_test.py

@@ -0,0 +1,20 @@
+#!/usr/bin/env python3
+"""Basic smoke test to verify the package was built correctly."""
+
+try:
+    import audiosub
+    print("✓ Package import successful")
+except ImportError as e:
+    print(f"✗ Package import failed: {e}")
+    exit(1)
+
+# Test that main function exists
+import audiosub
+
+if hasattr(audiosub, 'main'):
+    print("✓ Main function exists")
+else:
+    print("✗ Main function not found")
+    exit(1)
+
+print("✓ Smoke test passed")