add readme

Author: eff-kay

examples/youtube-video-transcription/README.md

@@ -0,0 +1,33 @@
+
+## Setup
+Create a new python virtual env and install the requirements:
+
+```bash
+python3 -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+```
+
+## Transcribing a single video
+update the `youtube_url` variable at line 36 in `youtube_video_transcription.py` with the url of the video you want to transcribe.
+
+Run the script:
+
+```bash
+python3 transcribe_youtube_video.py
+```
+The result should contain the transcription of the video.
+
+## Multiple Videos
+For transcribing a list of videos, update the `youtube_urls` variable at line 8 in `youtube_video_transcription.py` with the list of urls of the videos you want to transcribe.
+
+Then execute the script:
+
+```bash
+python transcribe_multiple_youtube_videos.py
+```
+
+This will print a list of transcription texts.
+
+
+For more information, read our docs at https://docs.slashml.com/reference/service/speech_to_text.html

examples/youtube-video-transcription/transcribe_multiple_videos.py

@@ -0,0 +1,13 @@
+from transcribe_youtube_video import transcribe_youtube_file
+
+def transcribe_multiple_youtube_videos(*, youtube_urls:list):
+    return list(map(transcribe_youtube_file, youtube_urls))
+
+
+if __name__=="__main__":
+    youtube_urls = ['https://youtu.be/5-TgqZ8nado','https://youtu.be/5-TgqZ8nado']
+
+    list_of_transcriptions = transcribe_multiple_youtube_videos(youtube_urls=youtube_url)
+    
+    from pprint import pprint as pp
+    pp(list_of_transcriptions)

…-transcription/transcribe_video_files.py …ranscription/transcribe_youtube_video.pyexamples/youtube-video-transcription/transcribe_video_files.py renamed to examples/youtube-video-transcription/transcribe_youtube_video.py examples/youtube-video-transcription/transcribe_video_files.py renamed to examples/youtube-video-transcription/transcribe_youtube_video.py

@@ -32,9 +32,6 @@ def transcribe_youtube_file(*, youtube_url:str):
 
     return response.transcription_data.transcription
 
-def transcribe_multiple_youtube_videos(*, youtube_urls:list):
-    return list(map(transcribe_youtube_file, youtube_urls))
-
 if __name__=='__main__':
     youtube_url = 'https://youtu.be/5-TgqZ8nado'
     print(transcribe_youtube_file(youtube_url=youtube_url))