# Pyaligner
![Read the Docs](https://img.shields.io/readthedocs/pyaligner?style=flat-square)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyaligner?style=flat-square)
**PyAligner** is a python library to automatically transcribe audio files and align them with the transcription. Is is based on OpenAI's [Whisper](https://github.com/openai/whisper) model and the [Montreal Forced Aligner (MFA)](https://montreal-forced-aligner.readthedocs.io/en/latest/) library. It also provides a friendly graphical user interface to facilitate the use of the library:
<p align="center">
<img src="docs/images/gui_example.png" alt="Your Image" width="200">
</p>
Check the [documentation](https://pyaligner.readthedocs.io/en/latest/) for more information about the installation and the complete user guide.
# Installation
You can install the library via pip:
```bash
pip install pyaligner
```
Although it is recommended to install it following the [installation guide](https://pyaligner.readthedocs.io/en/latest/install.html).
# Command Line Interface
Apart from the graphical interface, PyAligner has a command line interface to provide a greater flexibility and customization options. You can check the available commands by running:
```bash
pyaligner --help
```
Raw data
{
"_id": null,
"home_page": null,
"name": "pyaligner",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "python, pytorch, deep-learning, audio, audio-transcription, audio-text-alignment",
"author": null,
"author_email": "\u00c1lvaro Ramajo-Ballester <aramajo@ing.uc3m.es>",
"download_url": "https://files.pythonhosted.org/packages/12/12/4a2757f65dfe63b1ce4410b8b93ad1e3dca8f51392d543c06d814825fada/pyaligner-0.1.3.tar.gz",
"platform": null,
"description": "# Pyaligner\n\n![Read the Docs](https://img.shields.io/readthedocs/pyaligner?style=flat-square)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyaligner?style=flat-square)\n\n**PyAligner** is a python library to automatically transcribe audio files and align them with the transcription. Is is based on OpenAI's [Whisper](https://github.com/openai/whisper) model and the [Montreal Forced Aligner (MFA)](https://montreal-forced-aligner.readthedocs.io/en/latest/) library. It also provides a friendly graphical user interface to facilitate the use of the library:\n\n<p align=\"center\">\n <img src=\"docs/images/gui_example.png\" alt=\"Your Image\" width=\"200\">\n</p>\n\nCheck the [documentation](https://pyaligner.readthedocs.io/en/latest/) for more information about the installation and the complete user guide.\n\n# Installation\n\nYou can install the library via pip:\n\n```bash\npip install pyaligner\n```\n\nAlthough it is recommended to install it following the [installation guide](https://pyaligner.readthedocs.io/en/latest/install.html).\n\n\n# Command Line Interface\n\nApart from the graphical interface, PyAligner has a command line interface to provide a greater flexibility and customization options. You can check the available commands by running:\n\n```bash\npyaligner --help\n```\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Automatic audio transcriptor and audi-text aligner",
"version": "0.1.3",
"project_urls": {
"Bug Tracker": "https://github.com/ramajoballester/pyaligner/issues",
"Homepage": "https://github.com/ramajoballester/pyaligner"
},
"split_keywords": [
"python",
" pytorch",
" deep-learning",
" audio",
" audio-transcription",
" audio-text-alignment"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7d1055a445f4abaa0f8b06789f3ed38bdc2aaa367c7a583429b28168f8f9dc5c",
"md5": "00117cf99e0f9c4a6d3752231ed4f184",
"sha256": "5e76b235adaab98e74635545ba834f8c1883a020d210cb1815bd84ccbe4849c4"
},
"downloads": -1,
"filename": "pyaligner-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "00117cf99e0f9c4a6d3752231ed4f184",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 24140,
"upload_time": "2024-04-09T22:24:00",
"upload_time_iso_8601": "2024-04-09T22:24:00.960037Z",
"url": "https://files.pythonhosted.org/packages/7d/10/55a445f4abaa0f8b06789f3ed38bdc2aaa367c7a583429b28168f8f9dc5c/pyaligner-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "12124a2757f65dfe63b1ce4410b8b93ad1e3dca8f51392d543c06d814825fada",
"md5": "d1d1f11b06f5492883cfc3866f8d0459",
"sha256": "902d2053f146fa480cbac5d51e786e7392cb6612920518dad0d299ab53728006"
},
"downloads": -1,
"filename": "pyaligner-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "d1d1f11b06f5492883cfc3866f8d0459",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 60412,
"upload_time": "2024-04-09T22:24:02",
"upload_time_iso_8601": "2024-04-09T22:24:02.835515Z",
"url": "https://files.pythonhosted.org/packages/12/12/4a2757f65dfe63b1ce4410b8b93ad1e3dca8f51392d543c06d814825fada/pyaligner-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-09 22:24:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ramajoballester",
"github_project": "pyaligner",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "openai-whisper",
"specs": []
},
{
"name": "montreal-forced-aligner",
"specs": []
},
{
"name": "ipykernel",
"specs": []
},
{
"name": "pyqt",
"specs": []
}
],
"lcname": "pyaligner"
}