changes

Author: Zotify

CHANGELOG.md

@@ -2,8 +2,6 @@
 
 ## v1.0.0
 
-An unexpected reboot.
-
 ### BREAKING CHANGES AHEAD
 
 - Most components have been completely rewritten to address some fundamental design issues with the previous codebase, This update will provide a better base for new features in the future.
@@ -12,7 +10,7 @@ An unexpected reboot.
 
 ### Changes
 
-- Genre metadata available for tracks downloaded from an album
+- Genre metadata available for all tracks
 - Boolean command line options are now set like `--save-metadata` or `--no-save-metadata` for True or False
 - 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
@@ -24,10 +22,12 @@ An unexpected reboot.
 - 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
 - File metadata no longer uses sanitized file metadata, this will result in more accurate metadata.
-- Replaced ffmpy with custom implementation
+- Replaced ffmpy with custom implementation providing more tags
+- Fixed artist download missing some tracks
 
 ### Additions
 
+- 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`
   - `--category`/`-c` will limit search results to a certain type, accepted values are "album", "artist", "playlist", "track", "show", "episode". Accepts multiple choices.
@@ -52,13 +52,13 @@ An unexpected reboot.
   - `{album_artist}`
   - `{album_artists}`
   - `{duration}` (milliseconds)
+  - `{explicit}`
   - `{isrc}`
   - `{licensor}`
   - `{popularity}`
   - `{release_date}`
   - `{track_number}`
 - Genre information is now more accurate and is always enabled
-- New library location for playlists `playlist_library`
 - Added download option for "liked episodes" `--liked-episodes`/`-le`
 - Added `save_metadata` option to fully disable writing track metadata
 - Added support for ReplayGain
@@ -79,6 +79,7 @@ An unexpected reboot.
 - Removed `print_api_errors` because API errors are now treated like regular errors
 - Removed the following config options due to their corresponding features being removed:
   - `bulk_wait_time`
+  - `chunk_size`
   - `download_real_time`
   - `md_allgenres`
   - `md_genredelimiter`

LICENCE

@@ -1,4 +1,4 @@
-Copyright (c) 2022 Zotify Contributors
+Copyright (c) 2024 Zotify Contributors
 
 This software is provided 'as-is', without any express or implied
 warranty. In no event will the authors be held liable for any damages

Pipfile

@@ -0,0 +1,18 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+librespot = {git = "git+https://github.com/kokarare1212/librespot-python"}
+music-tag = {git = "git+https://zotify.xyz/zotify/music-tag"}
+mutagen = "*"
+pillow = "*"
+pwinput = "*"
+requests = "*"
+tqdm = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.11"

Pipfile.lock

@@ -1,13 +1,12 @@
-# STILL IN DEVELOPMENT, NOT RECOMMENDED FOR GENERAL USE!
-
-![Logo banner](https://s1.fileditch.ch/hOwJhfeCFEsYFRWUWaz.png)
+![Logo banner](./assets/banner.png)
 
 # Zotify
 
 A customizable music and podcast downloader. \
 Formerly ZSp‌otify.
 
-Available on [zotify.xyz](https://zotify.xyz/zotify/zotify) and [GitHub](https://github.com/zotify-dev/zotify).
+Available on [zotify.xyz](https://zotify.xyz/zotify/zotify) and [GitHub](https://github.com/zotify-dev/zotify). \
+Built on [Librespot](https://github.com/kokarare1212/librespot-python).
 
 ## Features
 
@@ -48,23 +47,23 @@ Downloads specified items. Accepts any combination of track, album, playlist, ep
 
 <details><summary>All configuration options</summary>
 
-| Config key              | Command line argument     | Description                                         |
-| ----------------------- | ------------------------- | --------------------------------------------------- |
-| path_credentials        | --path-credentials        | Path to credentials file                            |
-| path_archive            | --path-archive            | Path to track archive file                          |
-| music_library           | --music-library           | Path to root of music library                       |
-| podcast_library         | --podcast-library         | Path to root of podcast library                     |
-| mixed_playlist_library  | --mixed-playlist-library  | Path to root of mixed content playlist library      |
-| output_album            | --output-album            | File layout for saved albums                        |
-| output_playlist_track   | --output-playlist-track   | File layout for tracks in a playlist                |
-| output_playlist_episode | --output-playlist-episode | File layout for episodes in a playlist              |
-| output_podcast          | --output-podcast          | File layout for saved podcasts                      |
-| download_quality        | --download-quality        | Audio download quality (auto for highest available) |
-| audio_format            | --audio-format            | Audio format of final track output                  |
-| transcode_bitrate       | --transcode-bitrate       | Transcoding bitrate (-1 to use download rate)       |
-| 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                    |
+| Config key              | Command line argument     | Description                                         | Default                                                    |
+| ----------------------- | ------------------------- | --------------------------------------------------- | ---------------------------------------------------------- |
+| path_credentials        | --path-credentials        | Path to credentials file                            |                                                            |
+| path_archive            | --path-archive            | Path to track archive file                          |                                                            |
+| music_library           | --music-library           | Path to root of music library                       |                                                            |
+| podcast_library         | --podcast-library         | Path to root of podcast library                     |                                                            |
+| mixed_playlist_library  | --mixed-playlist-library  | Path to root of mixed content playlist library      |                                                            |
+| output_album            | --output-album            | File layout for saved albums                        | {album_artist}/{album}/{track_number}. {artists} - {title} |
+| output_playlist_track   | --output-playlist-track   | File layout for tracks in a playlist                | {playlist}/{playlist_number}. {artists} - {title}          |
+| output_playlist_episode | --output-playlist-episode | File layout for episodes in a playlist              | {playlist}/{playlist_number}. {episode_number} - {title}   |
+| output_podcast          | --output-podcast          | File layout for saved podcasts                      | {podcast}/{episode_number} - {title}                       |
+| download_quality        | --download-quality        | Audio download quality (auto for highest available) |                                                            |
+| audio_format            | --audio-format            | Audio format of final track output                  |                                                            |
+| transcode_bitrate       | --transcode-bitrate       | Transcoding bitrate (-1 to use download rate)       |                                                            |
+| 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       |
 
@@ -91,9 +90,9 @@ Zotify can be used as a user-friendly library for saving music, podcasts, lyrics
 Here's a very simple example of downloading a track and its metadata:
 
 ```python
-import zotify
+from zotify import Session
 
-session = zotify.Session.from_userpass(username="username", password="password")
+session = Session.from_userpass(username="username", password="password")
 track = session.get_track("4cOdK2wGLETKBW3PvgPWqT")
 output = track.create_output("./Music", "{artist} - {title}")
 
@@ -113,20 +112,14 @@ All new contributions should follow this principle to keep the program consisten
 
 ## Will my account get banned if I use this tool?
 
-No user has reported their account getting banned after 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://github.com/watsonbox/exportify) to keep backups of your playlists.
+Consider using [Exportify](https://watsonbox.github.io/exportify/) to keep backups of your playlists.
 
 ## Disclaimer
 
 Using Zotify violates Sp‌otify user guidelines and may get your account suspended.
 
-Zotify is intended to be used in compliance with DMCA, Section 1201, for educational, private and fair use, or any simlar laws in other regions. \
-Zotify contributors cannot be held liable for damages caused by the use of this tool. See the [LICENSE](./LICENCE) file for more details.
-
-## Acknowledgements
-
-- [Librespot-Python](https://github.com/kokarare1212/librespot-python) does most of the heavy lifting, it's used for authentication, fetching track data, and audio streaming.
-- [music-tag](https://github.com/KristoforMaynard/music-tag) is used for writing metadata into the downloaded files.
-- [FFmpeg](https://ffmpeg.org/) is used for transcoding audio.
+Zotify is intended to be used in compliance with DMCA, Section 1201, for educational, private and fair use, or any simlar laws in other regions.
+Zotify contributors are not liable for damages caused by the use of this tool. See the [LICENSE](./LICENCE) file for more details.

README.md

@@ -2,5 +2,6 @@ black
 flake8
 mypy
 pre-commit
+types-protobuf
 types-requests
 wheel

assets/banner.png

@@ -1,6 +1,6 @@
 [metadata]
 name = zotify
-version = 0.9.2
+version = 0.9.4
 author = Zotify Contributors
 description = A highly customizable music and podcast downloader
 long_description = file: README.md
@@ -33,6 +33,10 @@ console_scripts =
 
 [flake8]
 max-line-length = 160
+ignore =
+    E701
+    E704
+    W503
 
 [mypy]
 warn_unused_configs = True
@@ -43,6 +47,9 @@ ignore_missing_imports = True
 [mypy-music_tag]
 ignore_missing_imports = True
 
+[mypy-mutagen.*]
+ignore_missing_imports = True
+
 [mypy-pwinput]
 ignore_missing_imports = True