Merge branch 'unstable' into master

deepjyoti30 · deepjyoti30 · commit 0ca3d93d392d · 2021-08-01T14:47:39.000+05:30
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -0,0 +1,36 @@
+name: PyPI Release
+
+on:
+  release:
+    types: [published]
+
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the latest release code
+        uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+      - name: Install dependencies
+        run:  |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel twine
+      - name: Install ytmdl locally
+        run: python setup.py install
+      - name: Generate the completion files
+        run: python utils/completion.py
+      - name: List files in current directory
+        run: ls -al
+      - name: Build the dist
+        run: python setup.py sdist bdist_wheel
+      - name: Upload to PyPI
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: twine upload dist/*
+          
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@ build/
 dist/
 ytmdl.*
 ytmdl/__pycache__/*
+.cache
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 <div align="center">
 <h1>YouTube Music Downloader</h1>
-<h4>Download songs from YouTube by getting the audio from YouTube and the metadata from sources like Itunes and Gaana.</h4>
+<h4>Download songs from YouTube by getting the audio from YouTube and the metadata from sources like Itunes, Spotify, Gaana etc.</h4>
 </div>
 
 <div align="center" width="60%" height="auto">
@@ -38,7 +38,7 @@ Ytmdl also has an web app, you can try it out [here](https://ytmdl.deepjyoti30.d
 ## Why this?
 
 This app downloads a song by getting the audio from Youtube sources __using__ youtube-dl and then adds song information like
-artist name, album name, release date, thumbnail etc by fetching it from sources like Itunes, Gaana and other sources.
+artist name, album name, release date, thumbnail etc by fetching it from sources like Itunes, Spotify, Gaana and other sources.
 
 __NO__. YoutubeDL doesn't do that. All youtube-dl does is lets you download audio from a video that you specify.
 __This app is not yet another youtube-dl clone.__
@@ -68,6 +68,7 @@ If you like my work, consider buying me a coffee or donating. In case you want t
 - [PyPi](#pypi)
 - [Arch Linux](#arch-linux)
 - [Gentoo](#gentoo)
+- [NixOS](#nixos)
 - [Windows](#windows)
 - [Manual](#manual)
 
@@ -100,6 +101,14 @@ emerge -av --autounmask net-misc/ytmdl
 
 Available in **src_prepare-overlay** [here](https://gitlab.com/src_prepare/src_prepare-overlay)
 
+### NixOS
+
+`ytmdl` can be installed using Nix with the command
+
+```console
+nix-env -iA nixos.ytmdl
+```
+
 ### Windows
 
 You need to install `ffmpeg` in order for `ytmdl` to work properly. This can be done by downloading the `ffmpeg` binary from [here](https://ffmpeg.org/download.html). Once downloaded, extract the file and find the `ffmpeg.exe` file. Copy the directory's path and add it to PATH in the following way.
@@ -150,11 +159,12 @@ You can manually install `ytmdl` by cloning this repository and running the `set
 ```console
 usage: ytmdl [-h] [-q] [--song SONG-METADATA] [--choice CHOICE]
              [--artist ARTIST] [--album ALBUM] [--disable-metaadd]
-             [--skip-meta] [-m] [--itunes-id ITUNES_ID] [--disable-sort]
-             [--ask-meta-name] [--on-meta-error ON_META_ERROR] [--proxy URL]
-             [--url URL] [--list PATH TO LIST] [--nolocal] [--format FORMAT]
-             [--trim] [--version] [--keep-chapter-name]
-             [--download-archive FILE] [--pl-start NUMBER] [--pl-end NUMBER]
+             [--skip-meta] [-m] [--itunes-id ITUNES_ID]
+             [--spotify-id SPOTIFY_ID] [--disable-sort] [--ask-meta-name]
+             [--on-meta-error ON_META_ERROR] [--proxy URL] [--url URL]
+             [--list PATH TO LIST] [--nolocal] [--format FORMAT] [--trim]
+             [--version] [--keep-chapter-name] [--download-archive FILE]
+             [--ignore-chapters] [--pl-start NUMBER] [--pl-end NUMBER]
              [--pl-items ITEM_SPEC] [--ignore-errors] [--title-as-name]
              [--level LEVEL] [--disable-file] [--list-level]
              [SONG_NAME ...]
@@ -194,6 +204,8 @@ optional arguments:
                         file. The songs are matched by using the videoId. All
                         downloaded song Id's are automatically added to the
                         file.
+  --ignore-chapters     Ignore chapters if available in the video and treat it
+                        like one video
 
 Metadata:
   --song SONG-METADATA  The song to search in Metadata. Particularly useful
@@ -213,7 +225,11 @@ Metadata:
                         will override this option, pass only one of them.
   -m, --manual-meta     Manually enter song details.
   --itunes-id ITUNES_ID
-                        Direct lookup from itunes.
+                        Direct lookup from itunes. If passed, metadata will be
+                        automatically added.
+  --spotify-id SPOTIFY_ID
+                        Direct lookup for Spotify tracks using the ID. If
+                        passed, metadata will be automatically added.
   --disable-sort        Disable sorting of the metadata before asking for
                         input. Useful if the song is in some other language
                         and/or just a few providers are used.
@@ -278,6 +294,7 @@ As of the latest development branch, the following options can be changed from t
 | `DEFAULT_FORMAT`     | Default format of the song                         | mp3                            |
 | `ON_META_ERROR`      | What to do if error occurs while writing meta      | exit                           |
 | `ITUNES_COUNTRY`     | Which region to use while searching from Itunes    | US                             |
+| `SPOTIFY_COUNTRY`    | Which market to use while searching from Spotify   | US                             |
 
 ### Advanced Configuration
 
diff --git a/bin/ytmdl b/bin/ytmdl
@@ -96,7 +96,9 @@ def arguments():
     metadata_group.add_argument('-m', '--manual-meta', help="Manually enter song\
                         details.", action="store_true")
     metadata_group.add_argument(
-        '--itunes-id', help="Direct lookup from itunes.")
+        '--itunes-id', help="Direct lookup from itunes. If passed, metadata will be automatically added.")
+    metadata_group.add_argument(
+        "--spotify-id", help="Direct lookup for Spotify tracks using the ID. If passed, metadata will be automatically added.")
     metadata_group.add_argument("--disable-sort", help="Disable sorting of the metadata \
                         before asking for input. Useful if the song is in some other language \
                         and/or just a few providers are used.", action="store_true")
@@ -143,6 +145,9 @@ def arguments():
                         the passed file. The songs are matched by using the videoId. All downloaded \
                         song Id's are automatically added to the file.", default=None,
                         metavar="FILE")
+    parser.add_argument('--ignore-chapters', help="Ignore chapters if available in the video and treat \
+                        it like one video",
+                        action="store_true")
 
     playlist_group = parser.add_argument_group("Playlist")
     playlist_group.add_argument(
@@ -281,7 +286,7 @@ def main(args):
 
     songs_to_download = [{}]
     # If the chapters are present, we will have to iterate and extract each chapter
-    if chapters:
+    if chapters and not args.ignore_chapters:
         logger.info("The song has chapters in it.",
                     "Each part will be extracted and worked accordingly.")
 
diff --git a/examples/config b/examples/config
@@ -46,29 +46,53 @@
 # The METADATA_PROVIDERS value is a comma separated
 # values that specifies wich API providers to use for getting
 # the song metadata. Available values right now are:
-# itunes, gaana, deezer, lastfm, musicbrainz, saavn.
+#
+# ---------
+# itunes, spotify, gaana, deezer, lastfm, musicbrainz, saavn.
+# ---------
+#
 # Please check the github page of ytmdl for more information.
 #
-#METADATA_PROVIDERS = "itunes, gaana"
+#METADATA_PROVIDERS = "itunes, spotify, gaana"
 #
 #*****************************************#
 # The DEFAULT_FORMAT denotes what to use as default for downloading.
 # Available values are:
+#
+# ---------
 # mp3, m4a, opus
+# ---------
 #
 #DEFAULT_FORMAT = "mp3"
 #
 #*****************************************#
 # What to do when something goes wrong while adding the metadata. This can
 # happen for various reasons like lack of metadata or network issues.
 # Available options are:
+#
+# ---------
 # exit, skip, manual
+# ---------
 #
 #ON_META_ERROR = "exit"
 #****************************************#
 # ITUNES SETTINGS
 # Which region to use while searching from Itunes.
 #
+#
+# Country where the song is to be searched for in Itunes.
+# The country helps if you're looking for regional songs in
+# which case Itunes orders the results accordingly.
+#
 # By default, 'US' will be used.
+#
 #ITUNES_COUNTRY = "US"
+#
+# Country where the song is to be searched for in Spotify.
+# The country helps if you're looking for regional songs in
+# which case Spotify orders the results accordingly.
+#
+# By default, 'US' is used
+#
+#SPOTIFY_COUNTRY = "US"
 #
diff --git a/setup.py b/setup.py
@@ -22,13 +22,14 @@
     'ffmpeg-python',
     'pysocks',
     'unidecode',
-    'youtube_search',
+    'youtube-search-python',
     'pyDes',
     'urllib3',
     'simber',
     'rich',
     'musicbrainzngs',
-    'ytmusicapi'
+    'ytmusicapi',
+    'spotipy'
 ]
 
 
diff --git a/ytmdl/__version__.py b/ytmdl/__version__.py
@@ -1,2 +1,2 @@
 # Store the version of the package
-__version__ = "2021.06.26-1"
+__version__ = "2021.07.26.dev"
diff --git a/ytmdl/core.py b/ytmdl/core.py
@@ -43,9 +43,9 @@ def search(song_name, args) -> Union[str, str]:
             logger.info('Quiet is enabled')
 
         logger.info('Searching Youtube for {}{}{}'.format(
-                Fore.LIGHTYELLOW_EX,
-                song_name,
-                Style.RESET_ALL
+            Fore.LIGHTYELLOW_EX,
+            song_name,
+            Style.RESET_ALL
         ))
 
         data = yt.search(song_name, not args.disable_metaadd,
@@ -144,7 +144,7 @@ def convert(
     logger.debug("{}:{}".format(start, end))
     if start is not None and end is not None:
         conv_name = utility.extract_part_convert(
-                        path, passed_format, start, end)
+            path, passed_format, start, end)
 
         # We need to raise exception if something went wrong
         if type(conv_name) is not str:
@@ -218,6 +218,9 @@ def meta(conv_name: str, song_name: str, search_by: str, args):
     elif args.itunes_id:
         logger.info('Direct iTunes lookup for {}...'.format(args.itunes_id))
         TRACK_INFO = metadata.lookup_from_itunes(args.itunes_id)
+    elif args.spotify_id:
+        logger.info('Direct Spotify lookup for {}...'.format(args.spotify_id))
+        TRACK_INFO = metadata.lookup_from_spotify(args.spotify_id)
     else:
         # Else add metadata in ordinary way
         logger.info('Getting song data for {}...'.format(search_by))
diff --git a/ytmdl/defaults.py b/ytmdl/defaults.py
@@ -53,3 +53,5 @@ def __parse_dir_path(dir_path: str):
     ON_ERROR_DEFAULT = setupConfig.GIVE_DEFAULT(1, 'ON_META_ERROR')
 
     ITUNES_COUNTRY = setupConfig.GIVE_DEFAULT(1, 'ITUNES_COUNTRY')
+
+    SPOTIFY_COUNTRY = setupConfig.GIVE_DEFAULT(1, 'SPOTIFY_COUNTRY')
diff --git a/ytmdl/dir.py b/ytmdl/dir.py
@@ -197,6 +197,21 @@ def dry_cleanup(current_path, passed_name):
         new_basename = "{}.{}".format(passed_name, extension)
         DEST = defaults.DEFAULT.SONG_DIR
 
+        # NOTE: If the DEST is a dynamic directory, then we cannot
+        # do a dry cleanup. So we'll have to use the base directory
+        # instead.
+        if "$" in DEST:
+            logger.debug(DEST)
+
+            # pylama:ignore=E501
+            logger.warning(
+                "Destination is a dynamic directory but this is a dry cleanup. Don't pass `--skip-meta` if you don't want this!")
+
+            # Use the base directory
+            DEST = DEST[:DEST.find("$")]
+
+            logger.debug(f"Using {DEST} as destination instead")
+
         logger.debug("Moving to: {}".format(DEST))
 
         # Create the destination file name
diff --git a/ytmdl/meta/spotify.py b/ytmdl/meta/spotify.py
@@ -0,0 +1,72 @@
+"""
+Handle extracting metadata from Spotify
+
+We will use Spotify's API to search for tracks and show them
+to the user to be used accordingly.
+"""
+
+from spotipy import SpotifyClientCredentials
+from spotipy import Spotify
+
+from typing import Dict, List
+
+# Yeah I know, this is not a good idea but
+# asking the users for their own credentials is jus
+# not good enough.
+# NOTE: Raise an issue if you have a better idea
+# and NO, I don't wanna ask the user to enter these
+# creds.
+CLIENT_ID = "a166f23a5637429e8bd819df46fa034e"
+CLIENT_SECRET = "bbad17df3cde471ab969f081f2ea8bbb"
+
+
+class SpotifySong(object):
+    """
+    Class to store data about the songs fetched from
+    Spotify.
+
+    We need to clean the data into an object that can
+    be utilized if the user choses to add this song as
+    metadata.
+    """
+
+    def __init__(self, song: Dict) -> None:
+        self.track_name = song["name"]
+        self.release_date = song["album"]["release_date"]
+        self.artist_name = song["artists"][0]["name"]
+        self.provider = "spotify"
+        self.collection_name = song["album"]["name"]
+        self.primary_genre_name = ""  # Seems spotify doesn't provide genre
+        self.track_number = song["track_number"]
+        self.artwork_url_100 = song["album"]["images"][0]["url"]
+        self.track_time = song["duration_ms"]
+
+
+def search_song(
+    query,
+    country: str = "US",
+    limit: int = 25
+) -> List[SpotifySong]:
+    """
+    Search the song using the API through spotipy
+    and accordingly return the results.
+    """
+    spotify = Spotify(auth_manager=SpotifyClientCredentials(
+        client_id=CLIENT_ID, client_secret=CLIENT_SECRET))
+
+    response = spotify.search(
+        f"track:{query}", limit=limit, type="track", market=country)
+    items = [SpotifySong(item) for item in response["tracks"]["items"]]
+
+    return items
+
+
+def get_track_from_spotify(id, country: str = "US"):
+    """
+    Lookup the metadata by using the ID on spotify
+    """
+    spotify = Spotify(auth_manager=SpotifyClientCredentials(
+        client_id=CLIENT_ID, client_secret=CLIENT_SECRET))
+
+    track = spotify.track(id, market=country)
+    return SpotifySong(track)
diff --git a/ytmdl/metadata.py b/ytmdl/metadata.py
diff --git a/ytmdl/setupConfig.py b/ytmdl/setupConfig.py
diff --git a/ytmdl/yt.py b/ytmdl/yt.py

-Original file line number
+Diff line change
 dist/
 ytmdl.*
 ytmdl/__pycache__/*
 +.cache
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`# Store the version of the package`
`2`		`-__version__ = "2021.06.26-1"`
	`2`	`+__version__ = "2021.07.26.dev"`