From 4ca2f24411a5c237d3b83d23d5a8e21093a40fd3 Mon Sep 17 00:00:00 2001
From: elysianmyst <74355265+TrueMyst@users.noreply.github.com>
Date: Mon, 16 Dec 2024 12:29:12 +0600
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=A6=EF=B8=8F=20add=20toml=20module=20t?=
 =?UTF-8?q?o=20pyproject=20and=20update=20documentation?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- Added toml module to pyproject.toml for dependency management.
- Updated the documentation and README for clarity and consistency.
---
 .github/workflows/publish-to-pypi.yml |  3 ---
 README.md                             |  2 +-
 docs/guidebook/guide.rst              |  8 ++++++--
 poetry.lock                           | 13 ++++++++++++-
 pyproject.toml                        |  1 +
 5 files changed, 20 insertions(+), 7 deletions(-)

diff --git a/.github/workflows/publish-to-pypi.yml b/.github/workflows/publish-to-pypi.yml
index 72d3521..07b6808 100644
--- a/.github/workflows/publish-to-pypi.yml
+++ b/.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]'
 
diff --git a/README.md b/README.md
index 4f2ca3d..c8846d4 100644
--- a/README.md
+++ b/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]
diff --git a/docs/guidebook/guide.rst b/docs/guidebook/guide.rst
index 8dda618..a85027e 100644
--- a/docs/guidebook/guide.rst
+++ b/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,7 +56,7 @@ 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]
@@ -64,6 +64,10 @@ Like tracks, you can also create an album poster, follow these steps below.
    # 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.
diff --git a/poetry.lock b/poetry.lock
index cc3f5a7..721fad2 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -760,6 +760,17 @@ files = [
     {file = "threadpoolctl-3.5.0.tar.gz", hash = "sha256:082433502dd922bf738de0d8bcc4fdcbf0979ff44c42bd40f5af8a282f6fa107"},
 ]
 
+[[package]]
+name = "toml"
+version = "0.10.2"
+description = "Python Library for Tom's Obvious, Minimal Language"
+optional = false
+python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*"
+files = [
+    {file = "toml-0.10.2-py2.py3-none-any.whl", hash = "sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b"},
+    {file = "toml-0.10.2.tar.gz", hash = "sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f"},
+]
+
 [[package]]
 name = "tomli"
 version = "2.2.1"
@@ -860,4 +871,4 @@ files = [
 [metadata]
 lock-version = "2.0"
 python-versions = "^3.10"
-content-hash = "557e85ddca7669d679fd720ae96da141177fb95fec76189e3e7c2220875687f9"
+content-hash = "22a40347b0506fa99774f426bc7bd35ebc3da30a1d00556fd63511e53e29f92f"
diff --git a/pyproject.toml b/pyproject.toml
index 1d74d2a..ea941f5 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -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'