Metadata-Version: 2.1
Name: pyaligner
Version: 0.2.0
Summary: Automatic audio transcriptor and audi-text aligner
Author-email: Álvaro Ramajo-Ballester <aramajo@ing.uc3m.es>
Project-URL: Homepage, https://github.com/ramajoballester/pyaligner
Project-URL: Bug Tracker, https://github.com/ramajoballester/pyaligner/issues
Keywords: python,pytorch,deep-learning,audio,audio-transcription,audio-text-alignment
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: openai-whisper
Requires-Dist: montreal-forced-aligner
Provides-Extra: dev
Requires-Dist: ipykernel; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: bump-my-version; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx==7.1.2; extra == "docs"
Requires-Dist: sphinx_rtd_theme==1.3.0; extra == "docs"
Requires-Dist: sphinx-copybutton==0.5.1; extra == "docs"
Requires-Dist: sphinx-markdown-tables==0.0.17; extra == "docs"
Requires-Dist: sphinx-tabs; extra == "docs"
Requires-Dist: numpydoc==1.5.0; extra == "docs"
Requires-Dist: myst-parser==2.0.0; extra == "docs"
Provides-Extra: full
Requires-Dist: pyaligner[dev,docs]; extra == "full"

# 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="https://github.com/ramajoballester/pyaligner/blob/fdb6b6d8605dee9bb4f1c9c62210249ffdcc8631/docs/images/gui_example.png?raw=true" 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
```

