audio-transcriber


Nameaudio-transcriber JSON
Version 0.5.45 PyPI version JSON
download
home_pageNone
SummaryTranscribe your .wav .mp4 .mp3 .flac files to text or record your own audio!
upload_time2025-09-10 00:07:06
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Audio-Transcriber

![PyPI - Version](https://img.shields.io/pypi/v/audio-transcriber)
![PyPI - Downloads](https://img.shields.io/pypi/dd/audio-transcriber)
![GitHub Repo stars](https://img.shields.io/github/stars/Knuckles-Team/audio-transcriber)
![GitHub forks](https://img.shields.io/github/forks/Knuckles-Team/audio-transcriber)
![GitHub contributors](https://img.shields.io/github/contributors/Knuckles-Team/audio-transcriber)
![PyPI - License](https://img.shields.io/pypi/l/audio-transcriber)
![GitHub](https://img.shields.io/github/license/Knuckles-Team/audio-transcriber)

![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/Knuckles-Team/audio-transcriber)
![GitHub pull requests](https://img.shields.io/github/issues-pr/Knuckles-Team/audio-transcriber)
![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/Knuckles-Team/audio-transcriber)
![GitHub issues](https://img.shields.io/github/issues/Knuckles-Team/audio-transcriber)

![GitHub top language](https://img.shields.io/github/languages/top/Knuckles-Team/audio-transcriber)
![GitHub language count](https://img.shields.io/github/languages/count/Knuckles-Team/audio-transcriber)
![GitHub repo size](https://img.shields.io/github/repo-size/Knuckles-Team/audio-transcriber)
![GitHub repo file count (file type)](https://img.shields.io/github/directory-file-count/Knuckles-Team/audio-transcriber)
![PyPI - Wheel](https://img.shields.io/pypi/wheel/audio-transcriber)
![PyPI - Implementation](https://img.shields.io/pypi/implementation/audio-transcriber)

*Version: 0.5.45*

Transcribe your .wav .mp4 .mp3 .flac files to text or record your own audio!

This repository is actively maintained - Contributions are welcome!

Contribution Opportunities:
- Support new models

Wrapped around [OpenAI Whisper](https://pypi.org/project/openai-whisper)

<details>
  <summary><b>Usage:</b></summary>

| Short Flag | Long Flag   | Description                                                   |
|------------|-------------|---------------------------------------------------------------|
| -h         | --help      | See Usage                                                     |
| -b         | --bitrate   | Bitrate to use during recording                               |
| -c         | --channels  | Number of channels to use during recording                    |
| -d         | --directory | Directory to save recording                                   |
| -e         | --export    | Export txt, srt, and vtt files                                |
| -f         | --file      | File to transcribe                                            |
| -l         | --language  | Language to transcribe                                        |
| -m         | --model     | Model to use: <tiny, base, small, medium, large>              |
| -n         | --name      | Name of recording                                             |
| -r         | --record    | Specify number of seconds to record to record from microphone |

</details>

<details>
  <summary><b>Example:</b></summary>

```bash
audio-transcriber --file '~/Downloads/Federal_Reserve.mp4' --model 'large'
audio-transcriber --record 60 --directory '~/Downloads/' --name 'my_recording.wav' --model 'tiny'
```


</details>

<details>
  <summary><b>Model Information:</b></summary>

[Courtesy of and Credits to OpenAI: Whisper.ai](https://github.com/openai/whisper/blob/main/README.md)

|  Size  | Parameters | English-only model | Multilingual model | Required VRAM | Relative speed |
|:------:|:----------:|:------------------:|:------------------:|:-------------:|:--------------:|
|  tiny  |    39 M    |     `tiny.en`      |       `tiny`       |     ~1 GB     |      ~32x      |
|  base  |    74 M    |     `base.en`      |       `base`       |     ~1 GB     |      ~16x      |
| small  |   244 M    |     `small.en`     |      `small`       |     ~2 GB     |      ~6x       |
| medium |   769 M    |    `medium.en`     |      `medium`      |     ~5 GB     |      ~2x       |
| large  |   1550 M   |        N/A         |      `large`       |    ~10 GB     |       1x       |


</details>

<details>
  <summary><b>Installation Instructions:</b></summary>

## Use with AI

Configure `mcp.json`
```json
{
  "mcpServers": {
    "audio_transcriber": {
      "command": "uv",
      "args": [
        "run",
        "--with",
        "audio-transcriber",
        "audio-transcriber-mcp"
      ],
      "env": {
        "WHISPER_MODEL": "medium",            // Optional
        "TRANSCRIBE_DIRECTORY": "~/Downloads" // Optional
      },
      "timeout": 200000
    }
  }
}
```

### Deploy MCP Server as a container
```bash
docker pull knucklessg1/audio-transcriber:latest
```

Modify the `compose.yml`

```compose
services:
  audio-transcriber:
    image: knucklessg1/audio-transcriber:latest
    environment:
      - HOST=0.0.0.0
      - PORT=8021
    ports:
      - 8021:8021
```

### Install Python Package

```bash
python -m pip install audio-transcriber
```

or

```bash
uv pip install --upgrade audio-transcriber
```

##### Ubuntu Dependencies
```bash
sudo apt-get update
sudo apt-get install libasound-dev portaudio19-dev libportaudio2 libportaudiocpp0 ffmpeg gcc -y
```

</details>

<details>
  <summary><b>Repository Owners:</b></summary>


<img width="100%" height="180em" src="https://github-readme-stats.vercel.app/api?username=Knucklessg1&show_icons=true&hide_border=true&&count_private=true&include_all_commits=true" />

![GitHub followers](https://img.shields.io/github/followers/Knucklessg1)
![GitHub User's stars](https://img.shields.io/github/stars/Knucklessg1)
</details>

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "audio-transcriber",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Audel Rouhi <knucklessg1@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/ef/2d/dc3ce0f51c8eaed0c9867a4842b109afacc3e0d8ccbde7b000e1c8ff8d0c/audio_transcriber-0.5.45.tar.gz",
    "platform": null,
    "description": "# Audio-Transcriber\n\n![PyPI - Version](https://img.shields.io/pypi/v/audio-transcriber)\n![PyPI - Downloads](https://img.shields.io/pypi/dd/audio-transcriber)\n![GitHub Repo stars](https://img.shields.io/github/stars/Knuckles-Team/audio-transcriber)\n![GitHub forks](https://img.shields.io/github/forks/Knuckles-Team/audio-transcriber)\n![GitHub contributors](https://img.shields.io/github/contributors/Knuckles-Team/audio-transcriber)\n![PyPI - License](https://img.shields.io/pypi/l/audio-transcriber)\n![GitHub](https://img.shields.io/github/license/Knuckles-Team/audio-transcriber)\n\n![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/Knuckles-Team/audio-transcriber)\n![GitHub pull requests](https://img.shields.io/github/issues-pr/Knuckles-Team/audio-transcriber)\n![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/Knuckles-Team/audio-transcriber)\n![GitHub issues](https://img.shields.io/github/issues/Knuckles-Team/audio-transcriber)\n\n![GitHub top language](https://img.shields.io/github/languages/top/Knuckles-Team/audio-transcriber)\n![GitHub language count](https://img.shields.io/github/languages/count/Knuckles-Team/audio-transcriber)\n![GitHub repo size](https://img.shields.io/github/repo-size/Knuckles-Team/audio-transcriber)\n![GitHub repo file count (file type)](https://img.shields.io/github/directory-file-count/Knuckles-Team/audio-transcriber)\n![PyPI - Wheel](https://img.shields.io/pypi/wheel/audio-transcriber)\n![PyPI - Implementation](https://img.shields.io/pypi/implementation/audio-transcriber)\n\n*Version: 0.5.45*\n\nTranscribe your .wav .mp4 .mp3 .flac files to text or record your own audio!\n\nThis repository is actively maintained - Contributions are welcome!\n\nContribution Opportunities:\n- Support new models\n\nWrapped around [OpenAI Whisper](https://pypi.org/project/openai-whisper)\n\n<details>\n  <summary><b>Usage:</b></summary>\n\n| Short Flag | Long Flag   | Description                                                   |\n|------------|-------------|---------------------------------------------------------------|\n| -h         | --help      | See Usage                                                     |\n| -b         | --bitrate   | Bitrate to use during recording                               |\n| -c         | --channels  | Number of channels to use during recording                    |\n| -d         | --directory | Directory to save recording                                   |\n| -e         | --export    | Export txt, srt, and vtt files                                |\n| -f         | --file      | File to transcribe                                            |\n| -l         | --language  | Language to transcribe                                        |\n| -m         | --model     | Model to use: <tiny, base, small, medium, large>              |\n| -n         | --name      | Name of recording                                             |\n| -r         | --record    | Specify number of seconds to record to record from microphone |\n\n</details>\n\n<details>\n  <summary><b>Example:</b></summary>\n\n```bash\naudio-transcriber --file '~/Downloads/Federal_Reserve.mp4' --model 'large'\naudio-transcriber --record 60 --directory '~/Downloads/' --name 'my_recording.wav' --model 'tiny'\n```\n\n\n</details>\n\n<details>\n  <summary><b>Model Information:</b></summary>\n\n[Courtesy of and Credits to OpenAI: Whisper.ai](https://github.com/openai/whisper/blob/main/README.md)\n\n|  Size  | Parameters | English-only model | Multilingual model | Required VRAM | Relative speed |\n|:------:|:----------:|:------------------:|:------------------:|:-------------:|:--------------:|\n|  tiny  |    39 M    |     `tiny.en`      |       `tiny`       |     ~1 GB     |      ~32x      |\n|  base  |    74 M    |     `base.en`      |       `base`       |     ~1 GB     |      ~16x      |\n| small  |   244 M    |     `small.en`     |      `small`       |     ~2 GB     |      ~6x       |\n| medium |   769 M    |    `medium.en`     |      `medium`      |     ~5 GB     |      ~2x       |\n| large  |   1550 M   |        N/A         |      `large`       |    ~10 GB     |       1x       |\n\n\n</details>\n\n<details>\n  <summary><b>Installation Instructions:</b></summary>\n\n## Use with AI\n\nConfigure `mcp.json`\n```json\n{\n  \"mcpServers\": {\n    \"audio_transcriber\": {\n      \"command\": \"uv\",\n      \"args\": [\n        \"run\",\n        \"--with\",\n        \"audio-transcriber\",\n        \"audio-transcriber-mcp\"\n      ],\n      \"env\": {\n        \"WHISPER_MODEL\": \"medium\",            // Optional\n        \"TRANSCRIBE_DIRECTORY\": \"~/Downloads\" // Optional\n      },\n      \"timeout\": 200000\n    }\n  }\n}\n```\n\n### Deploy MCP Server as a container\n```bash\ndocker pull knucklessg1/audio-transcriber:latest\n```\n\nModify the `compose.yml`\n\n```compose\nservices:\n  audio-transcriber:\n    image: knucklessg1/audio-transcriber:latest\n    environment:\n      - HOST=0.0.0.0\n      - PORT=8021\n    ports:\n      - 8021:8021\n```\n\n### Install Python Package\n\n```bash\npython -m pip install audio-transcriber\n```\n\nor\n\n```bash\nuv pip install --upgrade audio-transcriber\n```\n\n##### Ubuntu Dependencies\n```bash\nsudo apt-get update\nsudo apt-get install libasound-dev portaudio19-dev libportaudio2 libportaudiocpp0 ffmpeg gcc -y\n```\n\n</details>\n\n<details>\n  <summary><b>Repository Owners:</b></summary>\n\n\n<img width=\"100%\" height=\"180em\" src=\"https://github-readme-stats.vercel.app/api?username=Knucklessg1&show_icons=true&hide_border=true&&count_private=true&include_all_commits=true\" />\n\n![GitHub followers](https://img.shields.io/github/followers/Knucklessg1)\n![GitHub User's stars](https://img.shields.io/github/stars/Knucklessg1)\n</details>\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Transcribe your .wav .mp4 .mp3 .flac files to text or record your own audio!",
    "version": "0.5.45",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "3d2b54ab7123649694eb4b289781cb2b47cc6ecc84799c8960fde113cd25048e",
                "md5": "6db7c884ec6d88cef88796e50492661e",
                "sha256": "e4acdd57a66c9fc7da13f8e55a7348dc0057138623c706453932432cc5fd9b62"
            },
            "downloads": -1,
            "filename": "audio_transcriber-0.5.45-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6db7c884ec6d88cef88796e50492661e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 11550,
            "upload_time": "2025-09-10T00:07:05",
            "upload_time_iso_8601": "2025-09-10T00:07:05.422412Z",
            "url": "https://files.pythonhosted.org/packages/3d/2b/54ab7123649694eb4b289781cb2b47cc6ecc84799c8960fde113cd25048e/audio_transcriber-0.5.45-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ef2ddc3ce0f51c8eaed0c9867a4842b109afacc3e0d8ccbde7b000e1c8ff8d0c",
                "md5": "cf742e1b1f357f9ba6061d4cf55670ff",
                "sha256": "78dff57061f2ca2f05172058e496e709a036dd671d1c20d791a584c4a3b10500"
            },
            "downloads": -1,
            "filename": "audio_transcriber-0.5.45.tar.gz",
            "has_sig": false,
            "md5_digest": "cf742e1b1f357f9ba6061d4cf55670ff",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 11916,
            "upload_time": "2025-09-10T00:07:06",
            "upload_time_iso_8601": "2025-09-10T00:07:06.260750Z",
            "url": "https://files.pythonhosted.org/packages/ef/2d/dc3ce0f51c8eaed0c9867a4842b109afacc3e0d8ccbde7b000e1c8ff8d0c/audio_transcriber-0.5.45.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-10 00:07:06",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "audio-transcriber"
}
        
Elapsed time: 1.76240s