Skip to content

Commit

Permalink
📦️ add toml module to pyproject and update documentation
Browse files Browse the repository at this point in the history
- Added toml module to pyproject.toml for dependency management.
- Updated the documentation and README for clarity and consistency.
  • Loading branch information
TrueMyst committed Dec 16, 2024
1 parent b57fc40 commit 4ca2f24
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 7 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/publish-to-pypi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ name: Upload Python Package To PyPi

on:
push:
branches:
- main

tags:
- 'v[0-9]+.[0-9]+.[0-9]'

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
8 changes: 6 additions & 2 deletions docs/guidebook/guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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.
13 changes: 12 additions & 1 deletion poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down

0 comments on commit 4ca2f24

Please sign in to comment.