Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ahmagdy/lyricsify
Spotify lyricsify
https://github.com/ahmagdy/lyricsify
Last synced: 10 days ago
JSON representation
Spotify lyricsify
- Host: GitHub
- URL: https://github.com/ahmagdy/lyricsify
- Owner: ahmagdy
- License: mit
- Created: 2019-09-29T19:41:52.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-10-25T08:11:06.000Z (about 1 year ago)
- Last Synced: 2024-06-21T18:54:36.690Z (5 months ago)
- Language: Go
- Size: 373 KB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Lyricsify
A tool to load the liked songs in Spotify, scrape the lyrics and add the ability to search through all of them.
### Use case
You're a Spotify user, you have a lot of songs in your playlist, you remembered multiple words or a sentence in one of the songs in your playlist, you tried to google it and you weren't able to find the song.
This tool should solve your problem because it will load all of your lyrics and allow you to search in all of it in an easy and reliable way.
https://github.com/ahmagdy/lyricsify/assets/10447926/9e635f0e-2dad-41ab-a36f-9cdd92c4374c
## How to use it
Consider checking [example](https://github.com/ahmagdy/lyricsify/blob/master/example/main.go) folder.
#### Config
Expected values to be set as Environment Variables or in a YAML file in the Documents folder.
```yaml
LYRICS_INDEX_NAME:
SPOTIFY_ID:
SPOTIFY_SECRET:
GENIUS_TOKEN:
GENIUS_BASE_URL:
MUSIXMATCH_TOKEN:
LYRICS_PROVIDER: genius|musixmatch
```
#### Sample
```go
ctx := context.Background()
// Initialize Instance of Lyricsify
svc, err := lyricsify.New(ctx, authServer.SpotifyClient())
// Load all of your songs in Liked Songs section, the key is the song name and the value is the artist/s
songsMap, err := lyricsify.LoadSongs(ctx)
// ......
// To get song lyrics as a text
lyrics, err := lyricsify.FetchLyrics(ctx, song, artists)
// Save Lyrics in the datastore
err := lyricsify.SaveLyrics(ctx, song, lyrics)
```
#### Docker Compose
Elasticsearch is required to run the tool, docker compose is ready to be used.
```bash
make d-up
make d-down
```
#### Tools used
- [Wire](https://github.com/google/wire)
- [goquery](https://github.com/PuerkitoBio/goquery)
- [elastic](https://github.com/olivere/elastic)
- [Viper](https://github.com/spf13/viper)
## License:
[The MIT License](https://github.com/ahmagdy/lyricsify/blob/master/LICENSE)