lyricdownloader/README.md

1.2 KiB

Lyricdownloader

This program is used to download lyrics for a song from the internet. There are two modes of operation:

(a) Scraping from google: This does not run in headless mode as Google does not show the lyrics in headless mode. So the program has to first open a chrome window, searches for the lyrics, and copies the lyrics returned by Google Search to a file defined by you. (b) Retrieving the lyrics using the Genius API.

Caveats

This program requires chrome to use, that is, you should have chrome installed to use this program.

TODOs

  • Refactor internal folder to this structure. Simplify package structure.
internal
| - usegenius.go # where you go all the genius processing
| - usegoogle.go # where you do all the google processing
| - cmdline.go # Where you initialize config and use flags
  • Setup the config file in its own config.go file
  • Specific the doc for go doc in the doc.go file. To see the generated documentation, run go doc lyricdownloader
  • Research how to view go doc locally
  • Fix generate_notes.py to fix generation of CHANGELOG.md
  • Add a demo heading in README.md
  • Sync over to Github
  • Add podman/Docker instructions
  • Add goreleaser