📦️ add toml module to pyproject and update documentation

- Added toml module to pyproject.toml for dependency management.
- Updated the documentation and README for clarity and consistency.

Author: TrueMyst

.github/workflows/publish-to-pypi.yml

@@ -3,9 +3,6 @@ name: Upload Python Package To PyPi
 
 on:
   push:
-    branches:
-      - main
-
     tags:
       - 'v[0-9]+.[0-9]+.[0-9]'
 

README.md

@@ -68,7 +68,7 @@ ps = poster.Poster("./")
 sp = spotify.Spotify(CLIENT_ID, CLIENT_SECRET)
 
 # Search for a track
-search = sp.get_track("Saturn by SZA", limit=1)
+search = sp.get_track("Saturn - SZA", limit=1)
 
 # Get the track's metadata and lyrics
 metadata = search[0]

docs/guidebook/guide.rst

@@ -25,7 +25,7 @@ To generate a track poster, follow the steps below.
    sp = spotify.Spotify(CLIENT_ID, CLIENT_SECRET)
 
    # Search for a track
-   search = sp.get_track("Saturn by SZA", limit=1)
+   search = sp.get_track("Saturn - SZA", limit=1)
 
    # Get the track's metadata and lyrics
    metadata = search[0]
@@ -56,14 +56,18 @@ Like tracks, you can also create an album poster, follow these steps below.
    sp = spotify.Spotify(CLIENT_ID, CLIENT_SECRET)
 
    # Search for an album
-   search = sp.get_album("Charm by Clairo", limit=1)
+   search = sp.get_album("Charm - Clairo", limit=1)
 
    # Get the album's metadata
    metadata = search[0]
 
    # Generate the album poster
    ps.album(metadata)
 
+.. tip::
+
+  Use a hyphen (-) between the track/album and the artist for more accurate results.
+
 .. seealso::
 
   For more details, see the :ref:`reference` section on using BeatPrints.

poetry.lock

@@ -20,6 +20,7 @@ lrclibapi = "^0.3.1"
 fonttools = "^4.54.1"
 questionary = "^2.0.1"
 rich = "^13.9.4"
+toml = "^0.10.2"
 
 [tool.poetry.scripts]
 beatprints = 'cli.prompt:main'