lyrics

README

Lyric API written in Golang

This library provides an API to search for lyrics from various providers.

Installing

go get

    $ go get github.com/rhnvrm/lyric-api-go

Usage Example

More examples can be found in the examples directory.

package main

import (
	"fmt"

	"github.com/rhnvrm/lyric-api-go"
)

func main() {
	var (
		artist = "John Lennon"
		song   = "Imagine"
	)

	l := lyrics.New()
	lyric, err := l.Search(artist, song)

	if err != nil {
		fmt.Printf("Lyrics for %v-%v were not found", artist, song)
	}
	fmt.Println(lyric)
}

Contributing

You are more than welcome to contribute to this project. Fork and make a Pull Request, or create an Issue if you see any problem.

Documentation

Index

• type Lyric
  • func New(o ...Option) Lyric
  • func (l *Lyric) Search(artist, song string) (string, error)
• type Option
  • func WithAllProviders() Option
  • func WithGeniusLyrics(accessToken string) Option
  • func WithLyricsWikia() Option
  • func WithSongLyrics() Option

Types

type Lyric

type Lyric struct {
	// contains filtered or unexported fields
}

Lyric API.

func New

func New(o ...Option) Lyric

New creates a new Lyric API, which can be used to Search for Lyrics using various providers. The default behaviour is to use all providers available, although it can be explicitly set to the same using, eg.

lyrics.New(WithAllProviders())

In case your usecase requires using only specific providers, you can provide New() with the specific WithXXXXProvider() as an optional parameter.

Eg. to attempt only with Lyrics Wikia:

lyrics.New(WithLyricsWikia())

Eg. to attempt with both Lyrics Wikia and Song Lyrics:

lyrics.New(WithLyricsWikia(), WithSongLyrics())

func (*Lyric) Search

func (l *Lyric) Search(artist, song string) (string, error)

Search attempts to search for lyrics using artist and song by trying various lyrics providers one by one.

type Option

type Option func(Lyric) Lyric

Option type describes Option Configuration Decorator return type.

func WithAllProviders

func WithAllProviders() Option

WithAllProviders is an Option Configuration Decorator that sets Lyric to attempt fetching lyrics using all providers.

func WithGeniusLyrics

func WithGeniusLyrics(accessToken string) Option

WithGenius is an Option Configuration Decorator that adds Genius Provider to the list of providers to attempt fetching lyrics from. It requires an additional access token which can be obtained using the developer portal (https://genius.com/developers)

func WithLyricsWikia

func WithLyricsWikia() Option

WithLyricsWikia is an Option Configuration Decorator that adds Lyrics Wikia Provider to the list of providers to attempt fetching lyrics from.

func WithSongLyrics

func WithSongLyrics() Option

WithSongLyrics is an Option Configuration Decorator that adds Song Lyrics Provider to the list of providers to attempt fetching lyrics from.