Add support for songs without lyrics #24

wenbang24 · 2024-12-28T00:06:15Z

One of my favourite songs, Swallow by Casiopea, does not have any lyrics (fusion jazz).
When I tried to use the CLI to make a poster, it presented me with this:

which would always show 'invalid range' no matter what I put in.

This pull request adds a check for if the returned lyrics are None, and raises NoLyricsAvailable.
It also allows users to make posters without lyrics: spotify.Spotify.track() now has a default of no lyrics. In the cli, the user will get an option not to paste lyrics if no lyrics are found.

Finally, it fixes a small line selection error in the docs (5-9 is five lines)

TrueMyst · 2024-12-28T13:33:57Z

Hey there,

The PR looks fantastic! I’ve never come across that issue before, but thank you so much for addressing it. I’m currently on vacation, so I might not be able to properly merge it until next Monday or so, but I’ll do my best to get to it sooner.

Here are a few things I wanted to point out:

The "5-9" in the docs was intentional. If you didn’t know, there’s supposed to be a line break between lines 6 and 7 in the lyrics of Saturn by SZA. You need to include that in the selection process, which gets stripped out later in the code.
You don’t need to include the if __name__ == "main" block in prompt.py. According to Poetry’s documentation, defining a main() function is enough if you want to run the script as a CLI.
LRClib contains almost all the lyrics, except for a few. Some of the missing ones are available on Genius. If you could double-check there, that would be awesome, but I understand it could get complicated, so it’s fine to leave it as is.
The song you searched is instrumental, which explains why there are no lyrics. BeatPrints is meant to generate posters for songs with lyrics, so it’d be great if we could filter out instrumental tracks using Spotify.

Other than that, everything looks great!

TrueMyst · 2024-12-28T13:41:31Z

Or we could do one thing: instead of removing instrumentals, we could turn it into a feature by generating a different type of poster specifically for them.

…to 6-9)'

wenbang24 · 2024-12-29T03:31:18Z

Hi!

Thanks for the feedback!

whoops my bad
Didn't know that, thanks!
sounds good, ill try and implement that (i'll make it optional though since Genius needs an API key)
nooooo pls dont filter them out, the posters still look nice without lyrics
although it could be nice to add something else in place of the lyrics

TrueMyst · 2024-12-29T04:47:07Z

Hey!

Great to see you here!

Thanks for making those changes, they look good. Just a quick heads-up, no need to mess with the alternative lyrics search through Genius for now. That’s something we’ll save for v2. It’ll be a bigger update, so no rush on that.

Also, I’m not gonna filter the songs. But yeah, we do need a way to figure out if a song is instrumental or not. LRClib has this instrumental method,

For Spotify, the Search endpoint doesn’t directly say if a track is instrumental, but the Audio Features endpoint has an instrumentalness attribute, which tells us how likely it is. It’s the best option.

So instead of checking whether the lyrics are available or not we should first check whether it's instrumental or not and then we proceed according to that.

Oh, and about the posters, some people suggested shrinking them for instrumental tracks since there’s no lyrics, but honestly, I’m not a fan of that. It’d look weird and just be a waste of resources. I’d rather fill that gap with something interesting. What do you think we should add?

TrueMyst · 2024-12-29T04:52:19Z

Anyways, sorry lol!!! I don't have my setup with me so I'm typing all of this with a phone. But it seems like you've already started working on genius, so I guess we should consider this as a minor update.

TrueMyst · 2024-12-29T04:54:28Z

If you want, you can come up with some prototype by using photoshop or photopea that you can show :))

wenbang24 · 2024-12-31T01:59:20Z

thanks for the feedback!

yes, I agree that shrinking the posters would look weird, especially when putting songs with and without lyrics next to each other.
didn't know that spotify had an instrumentalness feature (thats so cool lol) but yes ill try and implement a check before fetching lyrics
as for what could be put in the empty space, maybe a play/pause/progress thing could look cool? I saw this etsy listing:
and maybe we could grab the bottom thing and put it in the empty space (im not much of a graphic designer lol but ill try and whip something up)
also happy new year!

TrueMyst · 2024-12-31T08:51:06Z

I think it's best if we put some stats in the space, that would probably fix the problem.

And also happy new year to you :))

wenbang24 · 2024-12-31T23:56:44Z

after looking at the spotify documentation i found a few stats that we could include:

artist followers
a waveform visualisation of the audio (not really a stat but looks cool and ig is the equivalent of lyrics?)
- although the spotify code already looks like a waveform
the album the song is from (wouldnt really work for singles though)
tempo
number of streams
position on charts (might need a different api like chartmetric and i dont think that one is free)
energy, danceability, etc. (does anyone actually look at this though?)
tags/genres
which of these (or any others) do you think we should include?

TrueMyst · 2025-01-01T05:58:44Z

Hey!

So, we should probably avoid using too many third-party services. The more we rely on them, the messier it gets to deal with conflicts. Like, one might have a feature for a track or album, but another might not, so it’s best to keep things simple.

Here’s what I’m thinking:

We’ll use LRClib to check if a track is instrumental. If it is, we’ll pull some extra details from Spotify, like mood, genre, tempo, and stream count. For mood, we could use words like “Happy” if it crosses a certain threshold (e.g., x > 0.6). This way, we avoid empty spaces on the posters and keep them looking neat.

For tracks with no lyrics, I’m planning to add a sub-project under BeatPrints where users can upload lyrics to LRClib’s database. It’s a win-win. The more people use it, the more lyrics get added, and the fewer gaps we’ll have over time.

Also, I’m thinking of using textualize to make the CLI more fun and interactive in the future.

Oh, and about lyricsgenius, I think it’d be better to revert those changes for now. It’s just making things more complicated than they need to be.

Let me know what you think!

wenbang24 · 2025-01-02T06:31:51Z

sounds good! i'll start working on it
btw i've moved everything about lyricsgenius into a branch called genius on my fork (theyre not lost forever 👍)

wenbang24 · 2025-01-02T07:06:32Z

so turns out the only spotify api endpoint with genres is the artist endpoint (why don't they classify songs 😔)

wenbang24 · 2025-01-03T01:00:44Z

do you think we should keep the option for people to just have a blank poster without the instrumental text?

wenbang24 · 2025-01-03T01:02:50Z

also a lot of the songs in my jazz playlist aren't marked as instrumental (i dont think they're in lrclib database) so i changed it to not raise NoLyricsAvailable and just return the instrumental text

Edit: never mind, there was a bug in my testing script (whoops)
Edit 2: just in case, cli lets users pick whether to include instrumental text if instrumental is false and lyrics aren't found (i.e. not in lrclib database)

TrueMyst · 2025-01-03T04:28:53Z

Unrelated to pull request, but I can imagine getting addicted to getting these posters printed by professionals, which at that point probably means this tool won't really be as free as it claims to be for me 💸💸💸 😔

Honestly, same! That’s exactly why I made BeatPrints.. Etsy prices are no joke. The idea was to keep it budget-friendly, but hey, if you’re getting them professionally printed, your wall’s about to look 🎀

TrueMyst · 2025-01-03T04:30:02Z

do you think we should keep the option for people to just have a blank poster without the instrumental text?

I’d strongly recommend against it- I think a blank poster wouldn’t look all that great.

Since spotify.py, lyrics.py, and poster.py work together to make these, any issues can be fixed by tweaking how they connect to keep things running smoothly. If lyrics are not found, we can always prompt user to input it.

wenbang24 · 2025-01-03T08:58:21Z

I think a blank poster wouldn’t look all that great.

I agree, however i think having multiple instrumental posters next to each other all with the same text would look a bit weird.
What do you think? Maybe we could randomly pick from a list of instrumental texts?

TrueMyst · 2025-01-03T09:48:32Z

I forgot to mention, but the second text will be chosen randomly from a list. This way, it feels more natural and less repetitive. For now let's just focus getting this feature done. I might even fork your repo to make some nice changes :))

wenbang24 · 2025-01-04T06:05:19Z

anything else to do?

TrueMyst · 2025-01-04T09:10:13Z

Great, I'll look into the code and let you know! It might take some time, but hopefully I'll merge it as soon as possible.

TrueMyst · 2025-01-06T09:18:34Z

There are some bugs in your code, that I need to fix, as it may conflict with the API itself.

- added placeholders for instrumental tracks - added method to check if a track is instrumental - fixed prompt.py"

TrueMyst · 2025-01-08T10:05:26Z

I fixed some code, mind checking them? :)

wenbang24 · 2025-01-08T22:30:40Z

cli/prompt.py


    except errors.NoLyricsAvailable:
-        print("\n😦 • Couldn't find lyrics from sources.")
-        pasteLyrics = questionary.confirm(
-            "📋 • Would you like to paste the lyrics instead?", default=False


a lot of instrumental songs are not in the lrcAPI database, so I think we should still give users the option to mark a track as instrumental?

Marking a track as instrumental when it actually has lyrics but the API doesn’t provide them doesn’t sit right with me. It feels misleading. A better approach might be to label it as “Lyrics Unavailable” or allow users to manually input the lyrics if they want. This keeps things accurate and avoids confusion.

wenbang24 · 2025-01-08T22:31:14Z

apart from that, everything looks great 👍 🎉

TrueMyst

Alright time to merge it in!

TrueMyst · 2024-12-28T13:45:07Z

docs/guidebook/generate.rst

@@ -30,7 +30,7 @@ To generate a track poster, follow the steps below.
   # Get the track's metadata and lyrics
   metadata = search[0]
   lyrics = ly.get_lyrics(metadata)
-   highlighted_lyrics = ly.select_lines(lyrics, "5-9")
+   highlighted_lyrics = ly.select_lines(lyrics, "6-9")


It should be "5-9"

TrueMyst · 2025-01-09T04:43:01Z

cli/prompt.py


    except errors.NoLyricsAvailable:
-        print("\n😦 • Couldn't find lyrics from sources.")
-        pasteLyrics = questionary.confirm(
-            "📋 • Would you like to paste the lyrics instead?", default=False


Marking a track as instrumental when it actually has lyrics but the API doesn’t provide them doesn’t sit right with me. It feels misleading. A better approach might be to label it as “Lyrics Unavailable” or allow users to manually input the lyrics if they want. This keeps things accurate and avoids confusion.

wenbang24 added 5 commits December 27, 2024 22:35

add option for no lyrics if lyrics are not found

df7c141

add no lyrics check (lyrics was sometimes None)

242c74e

make lyrics optional

d8a2dcb

fix error in code example for track (5-9 is invalid, changed to 6-9)

4b104cb

change emoji

a6d159c

TrueMyst assigned TrueMyst and wenbang24 Dec 28, 2024

TrueMyst added bug Something isn't working enhancement New feature or request documentation Improvements or additions to documentation and removed enhancement New feature or request labels Dec 28, 2024

TrueMyst requested review from TrueMyst and removed request for TrueMyst December 28, 2024 13:45

wenbang24 added 2 commits December 29, 2024 13:51

revert 'fix error in code example for track (5-9 is invalid, changed …

45924ab

…to 6-9)'

remove if __name__ == "__main__" thing

891943f

TrueMyst mentioned this pull request Jan 1, 2025

Tracks without Lyrics can't be printed #26

Closed

wenbang24 force-pushed the main branch from e2ccd60 to 891943f Compare January 2, 2025 06:28

Merge branch 'TrueMyst:main' into main

ea71343

wenbang24 added 5 commits January 3, 2025 10:48

refactor: only one return

7b0030d

remove unnecessary check in prompt

6e03dfa

refactor: move instrumental note to consts.py

f1f9d16

undo refactor: only one return

824e3b3

update cli to handle instrumental tracks

c656f8f

wenbang24 added 3 commits January 3, 2025 12:19

raise NoLyricsAvailable if instrumental is not true

0d0dcae

change prompt

daef0e9

update cli to let users pick whether to add instrumental text or not

1e0fa73

change cli default to add instrumental text

7b445eb

wenbang24 and others added 3 commits January 4, 2025 16:50

add a few more options for instrumental text

bb0f159

add even more options

43e7ec0

Merge branch 'main' into main

9909c22

wenbang24 and others added 3 commits January 8, 2025 19:12

fix fake reference

9ab2a2d

added proper support for instrumental tracks

8eb630e

- added placeholders for instrumental tracks - added method to check if a track is instrumental - fixed prompt.py"

Merge remote-tracking branch 'origin/main'

c77d1d7

wenbang24 commented Jan 8, 2025

View reviewed changes

Merge branch 'main' into main

95c0d6b

TrueMyst approved these changes Jan 9, 2025

View reviewed changes

TrueMyst merged commit dc09f43 into TrueMyst:main Jan 9, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for songs without lyrics #24

Add support for songs without lyrics #24

wenbang24 commented Dec 28, 2024

TrueMyst commented Dec 28, 2024

TrueMyst commented Dec 28, 2024

wenbang24 commented Dec 29, 2024

TrueMyst commented Dec 29, 2024 •

edited

Loading

TrueMyst commented Dec 29, 2024 •

edited

Loading

TrueMyst commented Dec 29, 2024

wenbang24 commented Dec 31, 2024

TrueMyst commented Dec 31, 2024 •

edited

Loading

wenbang24 commented Dec 31, 2024

TrueMyst commented Jan 1, 2025

wenbang24 commented Jan 2, 2025

wenbang24 commented Jan 2, 2025

wenbang24 commented Jan 3, 2025

wenbang24 commented Jan 3, 2025 •

edited

Loading

TrueMyst commented Jan 3, 2025

TrueMyst commented Jan 3, 2025 •

edited

Loading

wenbang24 commented Jan 3, 2025 •

edited

Loading

TrueMyst commented Jan 3, 2025 •

edited

Loading

wenbang24 commented Jan 4, 2025

TrueMyst commented Jan 4, 2025

TrueMyst commented Jan 6, 2025

TrueMyst commented Jan 8, 2025

wenbang24 Jan 8, 2025

TrueMyst Jan 9, 2025

wenbang24 commented Jan 8, 2025

TrueMyst left a comment

TrueMyst Dec 28, 2024

TrueMyst Jan 9, 2025

Add support for songs without lyrics #24

Add support for songs without lyrics #24

Conversation

wenbang24 commented Dec 28, 2024

TrueMyst commented Dec 28, 2024

TrueMyst commented Dec 28, 2024

wenbang24 commented Dec 29, 2024

TrueMyst commented Dec 29, 2024 • edited Loading

TrueMyst commented Dec 29, 2024 • edited Loading

TrueMyst commented Dec 29, 2024

wenbang24 commented Dec 31, 2024

TrueMyst commented Dec 31, 2024 • edited Loading

wenbang24 commented Dec 31, 2024

TrueMyst commented Jan 1, 2025

wenbang24 commented Jan 2, 2025

wenbang24 commented Jan 2, 2025

wenbang24 commented Jan 3, 2025

wenbang24 commented Jan 3, 2025 • edited Loading

TrueMyst commented Jan 3, 2025

TrueMyst commented Jan 3, 2025 • edited Loading

wenbang24 commented Jan 3, 2025 • edited Loading

TrueMyst commented Jan 3, 2025 • edited Loading

wenbang24 commented Jan 4, 2025

TrueMyst commented Jan 4, 2025

TrueMyst commented Jan 6, 2025

TrueMyst commented Jan 8, 2025

wenbang24 Jan 8, 2025

Choose a reason for hiding this comment

TrueMyst Jan 9, 2025

Choose a reason for hiding this comment

wenbang24 commented Jan 8, 2025

TrueMyst left a comment

Choose a reason for hiding this comment

TrueMyst Dec 28, 2024

Choose a reason for hiding this comment

TrueMyst Jan 9, 2025

Choose a reason for hiding this comment

TrueMyst commented Dec 29, 2024 •

edited

Loading

TrueMyst commented Dec 29, 2024 •

edited

Loading

TrueMyst commented Dec 31, 2024 •

edited

Loading

wenbang24 commented Jan 3, 2025 •

edited

Loading

TrueMyst commented Jan 3, 2025 •

edited

Loading

wenbang24 commented Jan 3, 2025 •

edited

Loading

TrueMyst commented Jan 3, 2025 •

edited

Loading