# yt_audio_collector
*yt_audio_collector* is a genuine, lightweight library for creating hindi dataset for speech recognition from youtube.
## Documentation
Detailed documentation about the usage of the library can be found at [yt_audio_collector](https://nagalakshmi136.github.io/yt_audio_collector/). This is recommended for most cases. If you want to hastily download a single video, the [quick start](#Quickstart) guide below might be what you're looking for.
## Description
YouTube is the most popular video-sharing platform in the world and as a machine learning engineer or AI engineer, you may encounter a situation where you want to script something to create datasets for training speech recognition models in any
particular language for this we need audio and transcripts in that language.
For this, I present to you: *yt_audio_collector*.
## Quickstart
This guide covers the most basic usage of the library. For more detailed information, please refer to [yt_audio_collector.io](https://nagalakshmi136.github.io/yt_audio_collector/).
### Installation
yt_audio_collector requires an installation of Python 3.6 or greater, as well as pip. (Pip is typically bundled with Python [installations](https://python.org/downloads).)
To install from PyPI with pip:
```bash
$ python -m pip install yt_audio_collector
```
Sometimes, the PyPI release becomes slightly outdated. To install from the source with pip:
```bash
$ python -m pip install git+https://github.com/Nagalakshmi136/yt_audio_collector
```
### Using yt_audio_collector in a Python script
```python
>>> from yt_audio_collector.system_1.fetch_youtube_data import FetchValidYouTubeData
>>> yt_data = FetchValidYouTubeData()
>>> video_ids = yt_data.get_valid_video_ids('cricket news in hindi')
>>> from yt_audio_collector.system_2.preprocess_audio import PreProcessAudio
>>> PreProcessAudio(source_path, destination_path, background_sound).preprocess_audio()
```
## Cloning the repository
Clone the repository through the terminal using the command below:
```shell
git clone https://github.com/Nagalakshmi136/yt_audio_collector.git
```
create conda enviroment with the following command:
$ conda create --name yt-collector python=3.9
If poetry not available install poetry:
$ sudo apt install poetry
Install required pacakages from poetry with the following command:
$ poetry install
To execute the code run the command:
$ python main.py
Raw data
{
"_id": null,
"home_page": "https://github.com/Nagalakshmi136/yt_audio_collector",
"name": "yt-audio-collector",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "hindi dataset,yt_audio_collector,youtube,youtube hindi audio,youtube hindi transcripts",
"author": "Mannasamudram Nagalakshmi",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/dc/14/6aba2747a8f3cc8a871d8083a0e6d262c706919c4f49d8ad66795cb50083/yt_audio_collector-0.1.0.tar.gz",
"platform": null,
"description": "# yt_audio_collector\n\n*yt_audio_collector* is a genuine, lightweight library for creating hindi dataset for speech recognition from youtube.\n\n## Documentation\n\nDetailed documentation about the usage of the library can be found at [yt_audio_collector](https://nagalakshmi136.github.io/yt_audio_collector/). This is recommended for most cases. If you want to hastily download a single video, the [quick start](#Quickstart) guide below might be what you're looking for.\n\n## Description\n\nYouTube is the most popular video-sharing platform in the world and as a machine learning engineer or AI engineer, you may encounter a situation where you want to script something to create datasets for training speech recognition models in any \nparticular language for this we need audio and transcripts in that language.\nFor this, I present to you: *yt_audio_collector*.\n\n## Quickstart\n\nThis guide covers the most basic usage of the library. For more detailed information, please refer to [yt_audio_collector.io](https://nagalakshmi136.github.io/yt_audio_collector/).\n\n### Installation\n\nyt_audio_collector requires an installation of Python 3.6 or greater, as well as pip. (Pip is typically bundled with Python [installations](https://python.org/downloads).)\n\nTo install from PyPI with pip:\n\n```bash\n$ python -m pip install yt_audio_collector\n```\n\nSometimes, the PyPI release becomes slightly outdated. To install from the source with pip:\n\n```bash\n$ python -m pip install git+https://github.com/Nagalakshmi136/yt_audio_collector\n```\n### Using yt_audio_collector in a Python script\n\n\n```python\n >>> from yt_audio_collector.system_1.fetch_youtube_data import FetchValidYouTubeData\n >>> yt_data = FetchValidYouTubeData()\n >>> video_ids = yt_data.get_valid_video_ids('cricket news in hindi')\n >>> from yt_audio_collector.system_2.preprocess_audio import PreProcessAudio\n >>> PreProcessAudio(source_path, destination_path, background_sound).preprocess_audio()\n```\n\n## Cloning the repository\n\nClone the repository through the terminal using the command below:\n\n```shell\ngit clone https://github.com/Nagalakshmi136/yt_audio_collector.git\n```\n\ncreate conda enviroment with the following command: \n\n $ conda create --name yt-collector python=3.9\n\nIf poetry not available install poetry: \n\n $ sudo apt install poetry\n\nInstall required pacakages from poetry with the following command: \n\n $ poetry install\n\nTo execute the code run the command:\n\n $ python main.py\n",
"bugtrack_url": null,
"license": "",
"summary": "Create hindi language dataset for Speech Recognition from youtube",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://nagalakshmi136.github.io/yt_audio_collector/",
"Homepage": "https://github.com/Nagalakshmi136/yt_audio_collector",
"Repository": "https://github.com/Nagalakshmi136/yt_audio_collector"
},
"split_keywords": [
"hindi dataset",
"yt_audio_collector",
"youtube",
"youtube hindi audio",
"youtube hindi transcripts"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "32e08f17f2fc416dbccb130986a23026c15a36693b7f65fbf90ec399d5da2a65",
"md5": "c23fdc9e501812c3b0500fd280a35a56",
"sha256": "ecba29a8e94b326dfacba35754cb1386f48db16a8978ac9590369a1f615960f6"
},
"downloads": -1,
"filename": "yt_audio_collector-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c23fdc9e501812c3b0500fd280a35a56",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 12237,
"upload_time": "2024-03-01T07:09:56",
"upload_time_iso_8601": "2024-03-01T07:09:56.126760Z",
"url": "https://files.pythonhosted.org/packages/32/e0/8f17f2fc416dbccb130986a23026c15a36693b7f65fbf90ec399d5da2a65/yt_audio_collector-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dc146aba2747a8f3cc8a871d8083a0e6d262c706919c4f49d8ad66795cb50083",
"md5": "0bd9bfac80b7c30581b79d673743eae7",
"sha256": "74e542ec180fa1034df6ed484175430eacad811b6563730fffc21958e4c1c805"
},
"downloads": -1,
"filename": "yt_audio_collector-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "0bd9bfac80b7c30581b79d673743eae7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 10459,
"upload_time": "2024-03-01T07:09:58",
"upload_time_iso_8601": "2024-03-01T07:09:58.446669Z",
"url": "https://files.pythonhosted.org/packages/dc/14/6aba2747a8f3cc8a871d8083a0e6d262c706919c4f49d8ad66795cb50083/yt_audio_collector-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-01 07:09:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Nagalakshmi136",
"github_project": "yt_audio_collector",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "yt-audio-collector"
}