glyrics

README

gLyrics

Overview

gLyrics is a library for extracting lyrics from websites. It also comes with built-in support for searching for lyrics using the google custom search API (Note: Requires API token).

It comes with a command line tool with the same name which uses the gLyrics API to show lyrics.

Installation

go get github.com/gieseladev/glyrics/v3

Command Line Tool

TODO

Documentation

Overview

Package glyrics provides tools for extracting lyrics.

Index

• func Search(ctx context.Context, searcher search.Searcher, query string) <-chan *LyricsInfo
• func WithWorkers(ctx context.Context, workers int64) context.Context
• type LyricsInfo
  • func Extract(url string) (*LyricsInfo, error)
  • func ExtractFromRequest(req *request.Request) (*LyricsInfo, error)
  • func ExtractWithContext(ctx context.Context, url string) (*LyricsInfo, error)
  • func SearchFirst(ctx context.Context, searcher search.Searcher, query string) *LyricsInfo
  • func SearchN(ctx context.Context, searcher search.Searcher, query string, amount int) []LyricsInfo
• type LyricsOrigin

Functions

func Search

func Search(ctx context.Context, searcher search.Searcher, query string) <-chan *LyricsInfo

Search uses the searcher to search for lyrics based on the query. It returns a channel which sends lyrics infos. To stop sending, cancel the context.

func WithWorkers

func WithWorkers(ctx context.Context, workers int64) context.Context

WithWorkers sets the amount of workers to use for Search. The default is 3.

Types

type LyricsInfo

type LyricsInfo = lyrics.Info

LyricsInfo is an alias for lyrics.Info

func Extract

func Extract(url string) (*LyricsInfo, error)

Extract wraps the provided url in a Request and performs ExtractFromRequest.

func ExtractFromRequest

func ExtractFromRequest(req *request.Request) (*LyricsInfo, error)

ExtractFromRequest tries to extract lyrics from the provided Request. Errors from extracting lyrics are ignored. The only error returned by this function is when no extractor was able to extract any lyrics.

func ExtractWithContext

func ExtractWithContext(ctx context.Context, url string) (*LyricsInfo, error)

ExtractWithContext extracts the lyrics from the url using the context.

func SearchFirst

func SearchFirst(ctx context.Context, searcher search.Searcher, query string) *LyricsInfo

SearchFirst returns the first search result from the searcher for the query. Might return nil if the context is cancelled or no results are found.

func SearchN

func SearchN(ctx context.Context, searcher search.Searcher,
	query string, amount int) []LyricsInfo

SearchN returns a slice with at most amount lyrics infos in it.

type LyricsOrigin

type LyricsOrigin = lyrics.Origin

LyricsOrigin is an alias for lyrics.Origin