Skip to content

Latest commit

 

History

History
107 lines (60 loc) · 4.85 KB

Readme.md

File metadata and controls

107 lines (60 loc) · 4.85 KB
Raw

TRANSCRIBER TO BITCOIN TRANSCRIPT

This project converts YouTube videos to bitcoinscripts and opens a PR on bitcoinscript repo. It uses youwhisper to transcribe the videos, then collects meta data about the video using requests_html. It then uses the supplied cli arguments and file to open a Pull Request on the bitcoinscript repo.

Steps:

The step-by-step flow for the scripts are:

  • transcribe given video and generate the output file

  • authenticate the user to GitHub

  • fork the transcript repo/use their existing fork, clone it and branch out

  • copy the transcript file to the new transcript repo

  • commit new file and push

  • then open a PR

    or

  • add the backend url to a .env file as QUEUE_ENDPOINT

  • send the transcript data to the backend queue

Install/Uninstall

Navigate to the application directory and run the below commands:

python3 -m venv venv creates a virtual environment

source venv/bin/activate activates the virtual environment

pip3 install . --use-pep517 to install the application

To check the version: tstbtc --version view the application version

tstbtc --help view the application help

pip3 uninstall tstbtc to uninstall the application

Usage

tstbtc {video_id} {directory} create video transcript supplying the id of the YouTube video and the associated directory bitcointranscripts destination folder

Note: The https links need to be wrapped in quotes when running the command on zsh

tstbtc {audio_url} {directory} --title {title} create audio transcript supplying the url of the audio, the source/year and the title of the audio

To include optional metadata in your transcript, you can add the following parameters:

  • -t or --title: Supply transcribed file title in 'quotes'
  • -d or --date: Supply the event date in format 'yyyy-mm-dd'
  • -T or --tags: Supply the tags for the transcript in 'quotes' and separated by commas
  • -s or --speakers: Supply the speakers for the transcript in 'quotes' and separated by commas
  • -c or --category: Supply the category for the transcript in 'quotes' and separated by commas
  • -C or --chapters: Split the transcript into chapters based on the supplied timestamps in the youtube video.
  • -p or --pr: Open a PR on the bitcointranscripts repo

Examples

To transcribe this podcast episode from Stephan Livera's podcast with the associated metadata, we would run either of the below commands. The first uses short argument tags, while the second uses long argument tags. The result is the same.

  • tstbtc Nq6WxJ0PgJ4 bitcointranscripts/stephan-livera-podcast -t 'OP_Vault - A New Way to HODL?' -d '2023-01-30' -T 'op_vault' -s 'Stephan Livera, James O’Beirn' -c ‘podcast’
  • tstbtc Nq6WxJ0PgJ4 bitcointranscripts/stephan-livera-podcast --title 'OP_Vault - A New Way to HODL?' --date '2023-01-30' --tags 'op_vault' --speakers 'Stephan Livera, James O’Beirn' --category ‘podcast’

You can also transcribe a mp3 link, such as the following from Stephan Livera's podcast: https://anchor.fm/s/7d083a4/podcast/play/64348045/https%3A%2F%2Fd3ctxlq1ktw2nl.cloudfront.net%2Fstaging%2F2023-1-1%2Ff7fafb12-9441-7d85-d557-e9e5d18ab788.mp3

For demonstration purposes, let's substitute the link above with the following: websitelink.mp3. In this scenario, we would run the below command.

  • tstbtc websitelink.mp3 bitcointranscripts/stephan-livera-podcast --title 'SLP455 Anant Tapadia - Single Sig or Multi Sig?' --date '2023-02-01' --tags 'multisig' --speakers 'Stephan Livera, Anant Tapadia' --category 'podcast'

Testing

To run the unit tests

pytest -v -m main -s

To run the feature tests

pytest -v -m feature -s

To run the full test suite

pytest -v -s

OTHER REQUIREMENTS

  • To enable us fork bitcointranscript repo and open a PR, we require you to login into your GitHub account. Kindly install GITHUB CLI using the instructions on their repo here. Following the prompt, please select the below options from the prompt to login:

    • what account do you want to log into? Github.com

    • what is your preferred protocol for Git operations? SSH

    • Upload your SSH public key to your GitHub account? skip

    • How would you like to authenticate GitHub CLI? Login with a web browser

    • copy the generated one-time pass-code and paste in the browser to authenticate if you have enabled 2FA

  • Install FFmpeg

    • for Mac Os users, run brew install ffmpeg

    • for other users, follow the instruction on their site to install

License

Transcriber to Bitcoin Transcript is released under the terms of the MIT license. See LICENSE for more information or see https://opensource.org/licenses/MIT.