Skip to content

Latest commit

 

History

History
70 lines (46 loc) · 2.03 KB

README.md

File metadata and controls

70 lines (46 loc) · 2.03 KB

Build Status Go Report Card Coverage Status GoDoc license

golyrics

This is a simple scrapper package to fetch lyrics data from the Wikia website.

Installation

go get github.com/mamal72/golyrics

Usage

package main

import "github.com/mamal72/golyrics"

func main() {
    // Get track suggestions by searching
    suggestions, err := golyrics.SearchTrack("Blackfield Some Day") // []Track, error
    // OR
    suggestions, err := golyrics.SearchTrackByArtistAndName("Blackfield", "Some Day") // []Track, error

    // Let's check results
    if err != nil || len(suggestions) == 0 {
        // No lyrics found for this track :(
        // Try some other keywords or show some error to user
    }

    // Assign first result to the track
    track := suggestions[0] // Track

    // Now fetch the lyrics and set it back on the track    
    err := track.FetchLyrics() // error
    if err != nil {
        // Error fetching lyrics for the track
    }
    fmt.Printf("Lyrics of %s by %s: %s", track.Name, track.Artist, track.Lyrics)
}

Tests

go test

Ideas || Issues

Just fill an issue and describe it. I'll check it ASAP!

Contribution

You can fork the repository, improve or fix some part of it and then send the pull requests back if you want to see them here. I really appreciate that. ❤️

Remember to write a few tests for your code before sending pull requests.

License

MIT