LyricsScraperNET is a versatile .NET library that provides an API for searching song lyrics from various external providers.
- Multi-framework support: Compatible with
.NET Standard 2.x
,.NET 5
,.NET 6
,.NET 7
,.NET 8
. - Integrated logging: Effortless debugging and tracking.
- Modular architecture: Highly testable and customizable.
- Flexible configuration: Multiple ways to configure the library.
- NuGet support: Easy installation from NuGet.
The library currently supports the following providers:
- AZLyrics
- Genius
- MusixMatch
- SongLyrics
- LyricFind
- LyricsFreak (Coming soon 🚧. Issue #38)
- kpoplyrics (Coming soon 🚧. Issue #39)
- Letras.mus.br (Coming soon 🚧. Issue #40)
- darklyrics (Coming soon 🚧. Issue #41)
- vagalume (Coming soon 🚧. Issue #42)
- Lyrics (Coming soon 🚧. Issue #25)
Here’s a simple example to demonstrate how to initialize and use the library with all available providers:
using LyricsScraperNET;
using LyricsScraperNET.Models.Requests;
class Program
{
static async Task Main()
{
// Create an instance of LyricScraperClient with all providers
ILyricsScraperClient lyricsScraperClient = new LyricsScraperClient()
.WithAllProviders();
var searchRequest = new ArtistAndSongSearchRequest(
artist: "Metallica",
song: "Nothing Else Matters"
);
var searchResult = lyricsScraperClient.SearchLyric(searchRequest);
if (!searchResult.IsEmpty())
{
Console.WriteLine(searchResult.LyricText);
}
}
}
For more advanced usage, you can set up the LyricScraperClient
via dependency injection (IServiceCollection
) with configurations stored in IConfiguration
.
Explore additional examples in the LyricsScraperNET.Client project.
Install the package from NuGet:
dotnet add package LyricsScraperNET
Contributions are welcome!
- Fork the repository and create a Pull Request.
- Report issues or propose features via the Issues tab.
For direct feedback, feel free to reach out on Telegram.
If you find this project helpful, consider supporting it:
- Starring this repository on GitHub ⭐.
Your support helps keep this project alive and evolving!
This project is licensed under the MIT License.