various changes

Author: Zotify

.vscode/settings.json

@@ -1,7 +1,9 @@
 {
-    "editor.defaultFormatter": "ms-python.black-formatter",
     "editor.formatOnSave": true,
     "editor.codeActionsOnSave": {
-        "source.organizeImports": true
+        "source.organizeImports": "explicit"
+    },
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter"
     },
 }

CHANGELOG.md

@@ -15,9 +15,8 @@
 - Setting `--config` (formerly `--config-location`) can be set to "None" to not use any config file
 - Search result selector now accepts both comma-seperated and hyphen-seperated values at the same time
 - Renamed `--liked`/`-l` to `--liked-tracks`/`-lt`
-- Renamed `root_path` and `root_podcast_path` to `music_library` and `podcast_library`
+- Renamed `root_path` and `root_podcast_path` to `album_library` and `podcast_library`
 - `--username` and `--password` arguments now take priority over saved credentials
-- Regex pattern for cleaning filenames is now OS specific, allowing more usable characters on Linux & macOS.
 - On Linux both `config.json` and `credentials.json` are now kept under `$XDG_CONFIG_HOME/zotify/`, (`~/.config/zotify/` by default).
 - The output template used is now based on track info rather than search result category
 - Search queries with spaces no longer need to be in quotes
@@ -29,7 +28,7 @@
 
 - New library location for playlists `playlist_library`
 - Added new command line arguments
-  - `--library`/`-l` overrides both `music_library` and `podcast_library` options similar to `--output`/`-o`
+  - `--library`/`-l` overrides both `album_library` and `podcast_library` options similar to `--output`/`-o`
   - `--category`/`-c` will limit search results to a certain type, accepted values are "album", "artist", "playlist", "track", "show", "episode". Accepts multiple choices.
   - `--debug` shows full tracebacks on crash instead of just the final error message
   - Added new shorthand aliases to some options:
@@ -55,6 +54,9 @@
   - `{explicit}`
   - `{isrc}`
   - `{licensor}`
+  - `{playlist}`
+  - `{playlist_number}`
+  - `{playlist_owner}`
   - `{popularity}`
   - `{release_date}`
   - `{track_number}`

Pipfile

@@ -13,6 +13,11 @@ requests = "*"
 tqdm = "*"
 
 [dev-packages]
+black = "*"
+flake8 = "*"
+mypy = "*"
+types-protobuf = "*"
+types-requests = "*"
 
 [requires]
 python_version = "3.11"

Pipfile.lock

@@ -10,19 +10,20 @@ Built on [Librespot](https://github.com/kokarare1212/librespot-python).
 
 ## Features
 
-- Save tracks at up to 320kbps\*
+- Save tracks at up to 320kbps<sup>**1**</sup>
 - Save to most popular audio formats
 - Built in search
 - Bulk downloads
-- Downloads synced lyrics
+- Downloads synced lyrics<sup>**2**</sup>
 - Embedded metadata
 - Downloads all audio, metadata and lyrics directly, no substituting from other services.
 
-\*Non-premium accounts are limited to 160kbps
+**1**: Non-premium accounts are limited to 160kbps \
+**2**: Requires premium
 
 ## Installation
 
-Requires Python 3.10 or greater. \
+Requires Python 3.11 or greater. \
 Optionally requires FFmpeg to save tracks as anything other than Ogg Vorbis.
 
 Enter the following command in terminal to install Zotify. \
@@ -64,8 +65,6 @@ Downloads specified items. Accepts any combination of track, album, playlist, ep
 | ffmpeg_path             | --ffmpeg-path             | Path to ffmpeg binary                               |                                                            |
 | ffmpeg_args             | --ffmpeg-args             | Additional ffmpeg arguments when transcoding        |                                                            |
 | save_credentials        | --save-credentials        | Save login credentials to a file                    |                                                            |
-| save_subtitles          | --save-subtitles          |
-| save_artist_genres      | --save-arist-genres       |
 
 </details>
 
@@ -104,15 +103,15 @@ file.write_cover_art(track.get_cover_art())
 
 ## Contributing
 
-Pull requests are always welcome, but if adding an entirely new feature we encourage you to create an issue proposing the feature first so we can ensure it's something that fits sthe scope of the project.
+Pull requests are always welcome, but if adding an entirely new feature we encourage you to create an issue proposing the feature first so we can ensure it's something that fits the scope of the project.
 
 Zotify aims to be a comprehensive and user-friendly tool for downloading music and podcasts.
 It is designed to be simple by default but offer a high level of configuration for users that want it.
 All new contributions should follow this principle to keep the program consistent.
 
 ## Will my account get banned if I use this tool?
 
-There have been no confirmed cases of accounts getting banned as a result of using Zotify.
+There have been no *confirmed* cases of accounts getting banned as a result of using Zotify.
 However, it is still a possiblity and it is recommended you use Zotify with a burner account where possible.
 
 Consider using [Exportify](https://watsonbox.github.io/exportify/) to keep backups of your playlists.

README.md

@@ -1,4 +1,4 @@
-librespot>=0.0.9
+librespot@git+https://github.com/kokarare1212/librespot-python
 music-tag@git+https://zotify.xyz/zotify/music-tag
 mutagen
 Pillow

requirements.txt

@@ -1,7 +1,6 @@
 black
 flake8
 mypy
-pre-commit
 types-protobuf
 types-requests
 wheel

requirements_dev.txt

@@ -1,11 +1,11 @@
 [metadata]
 name = zotify
-version = 0.9.4
+version = 0.9.5
 author = Zotify Contributors
 description = A highly customizable music and podcast downloader
 long_description = file: README.md
 long_description_content_type = text/markdown
-keywords = python, music, podcast, downloader
+keywords = music, podcast, downloader
 licence = Zlib
 classifiers =
     Programming Language :: Python :: 3
@@ -17,9 +17,9 @@ classifiers =
 
 [options]
 packages = zotify
-python_requires = >=3.10
+python_requires = >=3.11
 install_requires =
-    librespot>=0.0.9
+    librespot@git+https://github.com/kokarare1212/librespot-python
     music-tag@git+https://zotify.xyz/zotify/music-tag
     mutagen
     Pillow

setup.cfg

@@ -97,7 +97,7 @@ def __init__(
             self.__language = language
 
     @staticmethod
-    def from_file(cred_file: Path, language: str = "en") -> Session:
+    def from_file(cred_file: Path | str, language: str = "en") -> Session:
         """
         Creates session using saved credentials file
         Args:
@@ -106,6 +106,8 @@ def from_file(cred_file: Path, language: str = "en") -> Session:
         Returns:
             Zotify session
         """
+        if not isinstance(cred_file, Path):
+            cred_file = Path(cred_file).expanduser()
         conf = (
             LibrespotSession.Configuration.Builder()
             .set_store_credentials(False)
@@ -118,7 +120,7 @@ def from_file(cred_file: Path, language: str = "en") -> Session:
     def from_userpass(
         username: str,
         password: str,
-        save_file: Path | None = None,
+        save_file: Path | str | None = None,
         language: str = "en",
     ) -> Session:
         """
@@ -133,6 +135,8 @@ def from_userpass(
         """
         builder = LibrespotSession.Configuration.Builder()
         if save_file:
+            if not isinstance(save_file, Path):
+                save_file = Path(save_file).expanduser()
             save_file.parent.mkdir(parents=True, exist_ok=True)
             builder.set_stored_credential_file(str(save_file))
         else:
@@ -144,7 +148,9 @@ def from_userpass(
         return Session(session, language)
 
     @staticmethod
-    def from_prompt(save_file: Path | None = None, language: str = "en") -> Session:
+    def from_prompt(
+        save_file: Path | str | None = None, language: str = "en"
+    ) -> Session:
         """
         Creates a session with username + password supplied from CLI prompt
         Args:

zotify/__init__.py

@@ -5,16 +5,15 @@
 
 from zotify.app import App
 from zotify.config import CONFIG_PATHS, CONFIG_VALUES
-from zotify.utils import OptionalOrFalse, SimpleHelpFormatter
+from zotify.utils import OptionalOrFalse
 
-VERSION = "0.9.4"
+VERSION = "0.9.5"
 
 
 def main():
     parser = ArgumentParser(
         prog="zotify",
         description="A fast and customizable music and podcast downloader",
-        formatter_class=SimpleHelpFormatter,
     )
     parser.add_argument(
         "-v",
@@ -53,7 +52,7 @@ def main():
     )
     parser.add_argument("--username", type=str, default="", help="Account username")
     parser.add_argument("--password", type=str, default="", help="Account password")
-    group = parser.add_mutually_exclusive_group(required=False)
+    group = parser.add_mutually_exclusive_group(required=True)
     group.add_argument(
         "urls",
         type=str,