Merge branch 'unstable'

Author: deepjyoti30

.github/CONTRIBUTING.md

@@ -31,10 +31,10 @@ Use [pylama](https://github.com/klen/pylama) for linting.
 3.Modules
 
 - Module names should be all lowercase
-- If more than one word, the words should be seperated by an underscore
+- If more than one word, the words should be separated by an underscore
 - It is preferrable to stick to single word for the module name
 
 4.Constants
 
 - Constant variables should be capitalized
-- If more than one word, the words can be seperated by an underscore
+- If more than one word, the words can be separated by an underscore

README.md

@@ -144,7 +144,7 @@ You can manually install `ytmdl` by cloning this repository and running the `set
 1. Clone this repo:
 
     ```console
-    git clone https://github.com/deepjyoti30/ytmdl   
+    git clone https://github.com/deepjyoti30/ytmdl
     ```
 
 1. Move into the `ytmdl` directory and run the `setup.py` script:
@@ -157,7 +157,7 @@ You can manually install `ytmdl` by cloning this repository and running the `set
 ## Usage
 
 ```console
-usage: ytmdl [-h] [-q] [--song SONG-METADATA] [--choice CHOICE]
+usage: ytmdl [-h] [-q] [-o SONG-DIR] [--song SONG-METADATA] [--choice CHOICE]
              [--artist ARTIST] [--album ALBUM] [--disable-metaadd]
              [--skip-meta] [-m] [--itunes-id ITUNES_ID]
              [--spotify-id SPOTIFY_ID] [--disable-sort] [--ask-meta-name]
@@ -178,6 +178,9 @@ optional arguments:
   -q, --quiet           Don't ask the user to select songs if more than one
                         search result. The first result in each case will be
                         considered.
+  -o, --output          The location for the song to be downloaded
+                        to. When no argument is passed, the default locations
+                        of SONG_DIR or XDG_MUSIC_DIR are used.
   --proxy URL           Use the specified HTTP/HTTPS/SOCKS proxy. To enable
                         SOCKS proxy, specify a proper scheme. For example
                         socks5://127.0.0.1:1080/. Pass in an empty string
@@ -233,7 +236,7 @@ Metadata:
   --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.
-  --ask-meta-name       Ask the user to enter a seperate name for searching
+  --ask-meta-name       Ask the user to enter a separate name for searching
                         the metadata (Default: false)
   --on-meta-error ON_META_ERROR
                         What to do if adding the metadata fails for some
@@ -244,7 +247,7 @@ Playlist:
   --pl-start NUMBER     Playlist video to start at (default is 1)
   --pl-end NUMBER       Playlist video to end at (default is last)
   --pl-items ITEM_SPEC  Playlist video items to download. Specify indices of
-                        the videos present in the playlist seperated by commas
+                        the videos present in the playlist separated by commas
                         like: '--playlist-items 1, 2, 4, 6' if you want to
                         download videos indexed 1, 2, 4 and 6. Range can also
                         be passed like: '--playlist-items 1-3, 5-7' to
@@ -288,7 +291,7 @@ As of the latest development branch, the following options can be changed from t
 
 | Name                 | Description                                        | Default                        |
 |:--------------------:|----------------------------------------------------|--------------------------------|
-| `SONG_DIR`           | Directory to save the songs in after editing       | Current direcotry              |
+| `SONG_DIR`           | Directory to save the songs in after editing       | Current directory              |
 | `SONG_QUALITY`       | Quality of the song                                | 320kbps                        |
 | `METADATA_PROVIDERS` | Which API providers to use for metadata            | all supported options are used |
 | `DEFAULT_FORMAT`     | Default format of the song                         | mp3                            |
@@ -302,7 +305,7 @@ As of the latest development branch, the following options can be changed from t
 
 `SONG_DIR` field also takes values that are extracted from the song being downloaded
 
-The `SONG_DIR` field needs to be passed some special values in order to achieve that. The string is scanned and when a `$` sign occurs, the special string will start and each directory can be seperated by using an `->` sign.
+The `SONG_DIR` field needs to be passed some special values in order to achieve that. The string is scanned and when a `$` sign occurs, the special string will start and each directory can be separated by using an `->` sign.
 
 To save the song in the `/dir/<album_name>/<artist_name>/<title>/<song_name>.mp3` format, the following needs to be added in the `SONG_DIR` field.
 
@@ -342,4 +345,3 @@ As of the latest source, the following options can be passed to the special stri
 | `Genre`       | Genre Of the Song             |
 | `TrackNumber` | TrackNumber Of the Song       |
 | `ReleaseDate` | ReleaseDate Of the Song       |
-

bin/ytmdl

@@ -39,6 +39,7 @@ from ytmdl.utils.archive import (
     is_present_in_archive,
     add_song_to_archive
 )
+from ytmdl.yt import is_yt_url
 from ytmdl.__version__ import __version__
 
 # init colorama for windows
@@ -67,6 +68,10 @@ def arguments():
                         if more than one search result.\
                         The first result in each case will be considered.",
                         action='store_true')
+    parser.add_argument('-o', '--output-dir',
+                        help="The location for the song to be downloaded\
+                        to. When no argument is passed, the default locations\
+                        of SONG_DIR or XDG_MUSIC_DIR are used.")
     metadata_group = parser.add_argument_group("Metadata")
     metadata_group.add_argument(
         '--song', help="The song to search in Metadata. \
@@ -102,7 +107,7 @@ def arguments():
     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")
-    metadata_group.add_argument("--ask-meta-name", help="Ask the user to enter a seperate \
+    metadata_group.add_argument("--ask-meta-name", help="Ask the user to enter a separate \
                         name for searching the metadata (Default: false)", action="store_true")
     metadata_group.add_argument("--on-meta-error", help="What to do if adding the metadata fails \
                         for some reasong like lack of metadata or perhaps a network issue. \
@@ -168,7 +173,7 @@ def arguments():
         "--pl-items",
         help="Playlist video items to download. \
              Specify indices of the videos present in the\
-             playlist seperated by commas like: '--playlist-items\
+             playlist separated by commas like: '--playlist-items\
               1, 2, 4, 6' if you want to download videos indexed\
              1, 2, 4 and 6. Range can also be passed like:\
              '--playlist-items 1-3, 5-7' to download the videos\
@@ -443,6 +448,14 @@ def pre_checks(args):
               for opt in vars(args))))
         exit(0)
 
+    # Ensure the output directory is legitimate
+    if (args.output_dir is not None):
+        if path.isdir(path.expanduser(args.output_dir)):
+            defaults.DEFAULT.SONG_DIR = path.expanduser(args.output_dir)
+        else:
+            logger.warning(
+                "{}: is an invalid path. Continuing with default.".format(args.output_dir))
+
     # Extract on-meta-error
     logger.debug("on_meta_error before: ", str(args.on_meta_error))
     on_meta_error = args.on_meta_error
@@ -502,7 +515,15 @@ def extract_data():
             logger.info("Downloading songs in {}".format(args.list))
             for song_name in songs:
                 logger.debug(song_name)
-                args.SONG_NAME = [song_name]
+
+                # Set the song name if an URL is not passed, else
+                # pass it as an URL
+                if is_yt_url(song_name):
+                    logger.debug("Detected passed song as URL")
+                    args.url = song_name
+                else:
+                    args.SONG_NAME = [song_name]
+
                 main(args)
         else:
             logger.info("{}: is empty".format(args.list))

ytmdl/core.py

@@ -114,7 +114,8 @@ def download(link, yt_title, args) -> str:
         defaults.DEFAULT.SONG_QUALITY,
         Style.RESET_ALL
     ))
-    path = yt.dw(link, args.proxy, yt_title, args.format)
+    path = yt.dw(link, args.proxy, yt_title,
+                 args.format, no_progress=args.quiet)
 
     if type(path) is not str:
         # Probably an error occured

ytmdl/dir.py

@@ -23,7 +23,7 @@ def __replace_special_characters(passed_name: str) -> str:
 
 
 def cleanup(TRACK_INFO, index, datatype, remove_cached=True):
-    """Move the song from temp to $HOME/Music dir."""
+    """Move the song from temp to the song dir."""
     try:
         SONG = glob.glob(os.path.join(
             defaults.DEFAULT.SONG_TEMP_DIR,
@@ -166,8 +166,8 @@ def make_custom_dir(DIR, TRACK_INFO):
         # Sometimes, certain strings have / in the name which creates
         # issues since those strings are used to create directories.
         # Whenever there is a /, replace it with -
-        # Sometimes strings also contains [\,?,",<>] which may cause error
-        dir_name = sub('[\\\\?<>/"]', "-", dir_name)
+        # Sometimes strings also contains [\,?,",<>, *] which may cause error
+        dir_name = sub('[\\\\?<>/"*]', "-", dir_name)
 
         new_dir = os.path.join(base_DIR, dir_name)
 

ytmdl/yt.py

@@ -95,6 +95,8 @@ def dw_using_yt(link, proxy, song_name, datatype, no_progress=False):
     }
 
     if not no_progress:
+        logger.debug("Enabling progress hook.")
+        logger.debug(f"Passed value for no_progress: {no_progress}")
         ydl_opts['progress_hooks'] = [progress_handler]
 
     if proxy is not None:
@@ -257,6 +259,14 @@ def is_playlist(url):
     return match(playlist_part, url)
 
 
+def is_yt_url(url):
+    """
+    Check if the passed URL is a valid youtube URL.
+    """
+    yt_url = r"https?://(www\.|music\.)?youtube\.com/watch\?v=.*?$"
+    return match(yt_url, url)
+
+
 def get_playlist(
     url,
     proxy,