https://github.com/mamal72/Golyrics
A simple Go package to fetch lyrics from Wikia
https://github.com/mamal72/Golyrics
api lyrics wikia
Last synced: over 1 year ago
JSON representation
A simple Go package to fetch lyrics from Wikia
- Host: GitHub
- URL: https://github.com/mamal72/Golyrics
- Owner: mamal72
- License: mit
- Created: 2016-11-18T04:40:37.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-06-30T08:33:13.000Z (about 8 years ago)
- Last Synced: 2024-10-25T05:25:19.058Z (over 1 year ago)
- Topics: api, lyrics, wikia
- Language: Go
- Homepage:
- Size: 129 KB
- Stars: 42
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/mamal72/golyrics)
[](https://goreportcard.com/report/github.com/mamal72/golyrics)
[](https://coveralls.io/github/mamal72/golyrics?branch=master)
[](https://godoc.org/github.com/mamal72/golyrics)
[](https://github.com/mamal72/golyrics/blob/master/LICENSE)
# golyrics
This is a simple scrapper package to fetch lyrics data from the [Wikia](http://lyrics.wikia.com) website.
## Installation
```bash
go get github.com/mamal72/golyrics
```
## Usage
```go
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
```bash
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. :heart:
Remember to write a few tests for your code before sending pull requests.
## License
> MIT