# WhisperSubs
[](https://pypi.org/project/whispersubs/)
[](https://pypi.org/project/whispersubs/)
[](https://github.com/andreabak/whispersubs/actions)
[](https://github.com/pypa/hatch)
[](https://github.com/astral-sh/ruff)
[](https://github.com/psf/black)
[](https://mypy-lang.org/)
[](https://github.com/andreabak/whispersubs/blob/main/LICENSE)
*Generate subtitles for your video or audio files using the power of AI.*
## Installation
Prerequisites:
- git for cloning this repo
- Python 3.8 or higher, with pip
For faster results, it is recommended to use a GPU with CUDA support. Running transcription on the CPU is significantly slower (up to 10~20x slower, depending on the hardware).
The optional dependencies required for GPU acceleration can be installed with the `[cuda]` extra when installing the package.
### Install latest release
Use the following to install the latest release in an isolated environment using [`pipx`](https://pipx.pypa.io), with CUDA libraries for GPU acceleration:
```shell
pipx install whispersubs[cuda]
```
N.B. omit the `[cuda]` extra if you don't have a GPU or don't want to use it.
Replace `pipx` with `pip` from the command above if you want to manually manage your own environment (or install user- or system-wide).
### Install repository version
You can install the latest version from this repository with the following command:
```shell
pipx install 'whispersubs[cuda] @ git+https://github.com/andreabak/whispersubs.git'
```
Usually this is going to be the same as the latest release, but it might contain some additional features or bugfixes that are not yet released.
## Usage
WhisperSubs can be used from the command line. The basic usage requires an input file, which will be the source for the transcription. The output will be a subtitle file in the SRT format in the same directory as the input file. The language will be automatically detected.
```shell
whispersubs <input_file>
```
For a full list of options, run:
```shell
whispersubs --help
```
Raw data
{
"_id": null,
"home_page": null,
"name": "whispersubs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "audio,subtitles,transcription,video,whisper",
"author": null,
"author_email": "abk16 <and.theunnamed@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/cd/50/cb8ea2837e978e093def6899178185ec77200b00c560407231d75a08abbb/whispersubs-0.1.2.tar.gz",
"platform": null,
"description": "# WhisperSubs\n\n[](https://pypi.org/project/whispersubs/)\n[](https://pypi.org/project/whispersubs/)\n[](https://github.com/andreabak/whispersubs/actions) \n[](https://github.com/pypa/hatch)\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/psf/black)\n[](https://mypy-lang.org/)\n[](https://github.com/andreabak/whispersubs/blob/main/LICENSE)\n\n*Generate subtitles for your video or audio files using the power of AI.*\n\n## Installation\n\nPrerequisites:\n- git for cloning this repo\n- Python 3.8 or higher, with pip\n\nFor faster results, it is recommended to use a GPU with CUDA support. Running transcription on the CPU is significantly slower (up to 10~20x slower, depending on the hardware). \nThe optional dependencies required for GPU acceleration can be installed with the `[cuda]` extra when installing the package.\n\n### Install latest release\nUse the following to install the latest release in an isolated environment using [`pipx`](https://pipx.pypa.io), with CUDA libraries for GPU acceleration:\n```shell\npipx install whispersubs[cuda]\n```\n\nN.B. omit the `[cuda]` extra if you don't have a GPU or don't want to use it.\n\nReplace `pipx` with `pip` from the command above if you want to manually manage your own environment (or install user- or system-wide).\n\n### Install repository version\nYou can install the latest version from this repository with the following command:\n```shell\npipx install 'whispersubs[cuda] @ git+https://github.com/andreabak/whispersubs.git'\n```\nUsually this is going to be the same as the latest release, but it might contain some additional features or bugfixes that are not yet released.\n\n## Usage\nWhisperSubs can be used from the command line. The basic usage requires an input file, which will be the source for the transcription. The output will be a subtitle file in the SRT format in the same directory as the input file. The language will be automatically detected.\n```shell\nwhispersubs <input_file>\n```\n\nFor a full list of options, run:\n```shell\nwhispersubs --help\n```\n",
"bugtrack_url": null,
"license": "LGPL-3.0",
"summary": "Transcribe audio/video files into subtitles",
"version": "0.1.2",
"project_urls": {
"Documentation": "https://github.com/andreabak/whispersubs#readme",
"Homepage": "https://github.com/andreabak/whispersubs",
"Issues": "https://github.com/andreabak/whispersubs/issues",
"Source": "https://github.com/andreabak/whispersubs"
},
"split_keywords": [
"audio",
"subtitles",
"transcription",
"video",
"whisper"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3894767468523cde9fcda7309c21c74f8d51be961d04632b449ac4b04477d408",
"md5": "c4153596b5caf1aefcbf7df61b7a4c91",
"sha256": "d6e7ea76f758e5af9ea9c9f74bfdc6eb9d73f65e6f5609c5683fab674c39ea8a"
},
"downloads": -1,
"filename": "whispersubs-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c4153596b5caf1aefcbf7df61b7a4c91",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11069,
"upload_time": "2024-03-17T16:55:33",
"upload_time_iso_8601": "2024-03-17T16:55:33.490451Z",
"url": "https://files.pythonhosted.org/packages/38/94/767468523cde9fcda7309c21c74f8d51be961d04632b449ac4b04477d408/whispersubs-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "cd50cb8ea2837e978e093def6899178185ec77200b00c560407231d75a08abbb",
"md5": "6de6070b312349d5ab93b0ed38134e7e",
"sha256": "89680c2f281564531f50dac7566b12b49214fc2c662abe54b2e0085675642f34"
},
"downloads": -1,
"filename": "whispersubs-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "6de6070b312349d5ab93b0ed38134e7e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 12912,
"upload_time": "2024-03-17T16:55:32",
"upload_time_iso_8601": "2024-03-17T16:55:32.411926Z",
"url": "https://files.pythonhosted.org/packages/cd/50/cb8ea2837e978e093def6899178185ec77200b00c560407231d75a08abbb/whispersubs-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-17 16:55:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "andreabak",
"github_project": "whispersubs#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "whispersubs"
}
JSON
