21 Jan update

This commit is contained in:
Nitesh Sawant
2018-01-22 23:47:56 +05:30
12 changed files with 176 additions and 100 deletions

View File

@@ -4,12 +4,36 @@ python:
- "3.4"
- "3.5"
- "3.6"
install:
before_install:
- sudo apt-get -qq update
- sudo apt-get -y install autoconf automake build-essential libass-dev libfreetype6-dev libtheora-dev libtool libva-dev libvdpau-dev libvorbis-dev libxcb1-dev libxcb-shm0-dev libxcb-xfixes0-dev pkg-config texinfo wget zlib1g-dev
- sudo apt-get -y install yasm nasm libmp3lame-dev
- pip install -r requirements.txt
- pip install tinydownload
- pip install codecov
- pip install pytest-cov
addons:
apt:
packages:
- automake
- autoconf
- build-essential
- libass-dev
- libfreetype6-dev
- libtheora-dev
- libtool
- libva-dev
- libvdpau-dev
- libvorbis-dev
- libxcb1-dev
- libxcb-shm0-dev
- libxcb-xfixes0-dev
- pkg-config
- texinfo
- zlib1g-dev
- yasm
- nasm
- libmp3lame-dev
install:
- pip install -r requirements.txt
- tinydownload 05861434675432854607 -o ~/bin/ffmpeg
- chmod 755 ~/bin/ffmpeg
script: python -m pytest test
script: python -m pytest test --cov=.
after_success: codecov

View File

@@ -1,6 +1,7 @@
# Spotify-Downloader
[![Build Status](https://travis-ci.org/ritiek/spotify-downloader.svg?branch=master)](https://travis-ci.org/ritiek/spotify-downloader)
[![Coverage Status](https://codecov.io/gh/ritiek/spotify-downloader/branch/master/graph/badge.svg)](https://codecov.io/gh/ritiek/spotify-downloader)
[![Docker Build Status](https://img.shields.io/docker/build/ritiek/spotify-downloader.svg)](https://hub.docker.com/r/ritiek/spotify-downloader)
- Downloads songs from YouTube in an MP3 format by using Spotify's HTTP link.
@@ -89,8 +90,8 @@ but make sure `$ python -V` gives you a `Python 3.x.x`!
```
usage: spotdl.py [-h]
(-s SONG | -l LIST | -p PLAYLIST | -b ALBUM | -u USERNAME)
[-m] [-nm] [-a] [-f FOLDER] [--overwrite {skip,force,prompt}]
[-i INPUT_EXT] [-o OUTPUT_EXT] [-dm] [-d] [-mo]
[-m] [-nm] [-a] [-f FOLDER] [--overwrite {force,prompt,skip}]
[-i INPUT_EXT] [-o OUTPUT_EXT] [-ff] [-dm] [-d] [-mo] [-ns]
[-ll {INFO,WARNING,ERROR,DEBUG}]
Download and convert songs from Spotify, Youtube etc.
@@ -114,8 +115,8 @@ optional arguments:
ffmpeg (default: False)
-f FOLDER, --folder FOLDER
path to folder where files will be stored in (default:
Music/)
--overwrite {skip,force,prompt}
Music)
--overwrite {force,prompt,skip}
change the overwrite policy (default: prompt)
-i INPUT_EXT, --input-ext INPUT_EXT
prefered input format .m4a or .webm (Opus) (default:
@@ -123,14 +124,20 @@ optional arguments:
-o OUTPUT_EXT, --output-ext OUTPUT_EXT
prefered output extension .mp3 or .m4a (AAC) (default:
.mp3)
-ff, --file-format File format to save the downloaded song with, each tag
is surrounded by curly braces. Possible formats:
['track_name', 'artist', 'album', 'album_artist',
'genre', 'disc_number', 'duration', 'year',
'original_date', 'track_number', 'total_tracks',
'isrc'] (default: {artist} - {track_name})
-dm, --download-only-metadata
download songs for which metadata is found (default:
False)
-d, --dry-run Show only track title and YouTube URL (default: False)
-mo, --music-videos-only
Search only for music on Youtube (default: False)
-ps, --preserve-spaces
Preserve spaces on file names (default: False)
-ns, --no-spaces Replace spaces with underscores in file names
(default: False)
-ll {INFO,WARNING,ERROR,DEBUG}, --log-level {INFO,WARNING,ERROR,DEBUG}
set log verbosity (default: INFO)
```

View File

@@ -31,9 +31,8 @@ def song(input_song, output_song, folder, avconv=False):
class Converter:
def __init__(self, input_song, output_song, folder):
self.input_song = input_song
self.output_song = output_song
self.folder = folder
self.input_file = os.path.join(folder, input_song)
self.output_file = os.path.join(folder, output_song)
def with_avconv(self):
if log.level == 10:
@@ -42,8 +41,8 @@ class Converter:
level = '0'
command = ['avconv', '-loglevel', level, '-i',
os.path.join(self.folder, self.input_song), '-ab', '192k',
os.path.join(self.folder, self.output_song)]
self.input_file, '-ab', '192k',
self.output_file]
log.debug(command)
return subprocess.call(command)
@@ -54,8 +53,8 @@ class Converter:
if not log.level == 10:
ffmpeg_pre += '-hide_banner -nostats -v panic '
input_ext = self.input_song.split('.')[-1]
output_ext = self.output_song.split('.')[-1]
input_ext = self.input_file.split('.')[-1]
output_ext = self.output_file.split('.')[-1]
if input_ext == 'm4a':
if output_ext == 'mp3':
@@ -69,9 +68,8 @@ class Converter:
elif output_ext == 'm4a':
ffmpeg_params = '-cutoff 20000 -c:a libfdk_aac -b:a 192k -vn '
command = '{0}-i {1} {2}{3}'.format(
ffmpeg_pre, os.path.join(self.folder, self.input_song),
ffmpeg_params, os.path.join(self.folder, self.output_song)).split(' ')
ffmpeg_pre += ' -i'
command = ffmpeg_pre.split() + [self.input_file] + ffmpeg_params.split() + [self.output_file]
log.debug(command)
return subprocess.call(command)

View File

@@ -1,3 +1,5 @@
from core import internals
import logging
import yaml
import argparse
@@ -19,7 +21,8 @@ default_conf = { 'spotify-downloader':
'download-only-metadata' : False,
'dry-run' : False,
'music-videos-only' : False,
'preserve-spaces' : False,
'no-spaces' : False,
'file-format' : '{artist} - {track_name}',
'log-level' : 'INFO' }
}
@@ -50,13 +53,16 @@ def get_config(config_file):
return cfg['spotify-downloader']
def get_arguments(to_group=True, raw_args=None):
def get_arguments(raw_args=None, to_group=True, to_merge=True):
parser = argparse.ArgumentParser(
description='Download and convert songs from Spotify, Youtube etc.',
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
config_file = os.path.join(sys.path[0], 'config.yml')
config = merge(default_conf, get_config(config_file))
if to_merge:
config_file = os.path.join(sys.path[0], 'config.yml')
config = merge(default_conf['spotify-downloader'], get_config(config_file))
else:
config = default_conf['spotify-downloader']
if to_group:
group = parser.add_mutually_exclusive_group(required=True)
@@ -84,7 +90,7 @@ def get_arguments(to_group=True, raw_args=None):
help='Use avconv for conversion otherwise set defaults to ffmpeg',
action='store_true')
parser.add_argument(
'-f', '--folder', default=config['folder'],
'-f', '--folder', default=os.path.relpath(config['folder'], os.getcwd()),
help='path to folder where files will be stored in')
parser.add_argument(
'--overwrite', default=config['overwrite'],
@@ -96,6 +102,12 @@ def get_arguments(to_group=True, raw_args=None):
parser.add_argument(
'-o', '--output-ext', default=config['output-ext'],
help='prefered output extension .mp3 or .m4a (AAC)')
parser.add_argument(
'-ff', '--file-format', default=config['file-format'],
help='File format to save the downloaded song with, each tag '
'is surrounded by curly braces. Possible formats: '
'{}'.format([internals.formats[x] for x in internals.formats]),
action='store_true')
parser.add_argument(
'-dm', '--download-only-metadata', default=config['download-only-metadata'],
help='download songs for which metadata is found',
@@ -109,8 +121,8 @@ def get_arguments(to_group=True, raw_args=None):
help='Search only for music on Youtube',
action='store_true')
parser.add_argument(
'-ps', '--preserve-spaces', default=config['preserve-spaces'],
help='Preserve spaces on file names',
'-ns', '--no-spaces', default=config['no-spaces'],
help='Replace spaces with underscores in file names',
action='store_true')
parser.add_argument(
'-ll', '--log-level', default=config['log-level'],

View File

@@ -1,4 +1,5 @@
from core.const import log
from slugify import SLUG_OK, slugify
from core import const
try:
from slugify import SLUG_OK, slugify
@@ -7,6 +8,21 @@ except ImportError:
import os
log = const.log
formats = { 0 : 'track_name',
1 : 'artist',
2 : 'album',
3 : 'album_artist',
4 : 'genre',
5 : 'disc_number',
6 : 'duration',
7 : 'year',
8 : 'original_date',
9 : 'track_number',
10 : 'total_tracks',
11 : 'isrc' }
def input_link(links):
""" Let the user input a choice. """
@@ -47,19 +63,37 @@ def is_youtube(raw_song):
return status
def generate_songname(tags):
def generate_songname(file_format, tags):
""" Generate a string of the format '[artist] - [song]' for the given spotify song. """
raw_song = u'{0} - {1}'.format(tags['artists'][0]['name'], tags['name'])
return raw_song
format_tags = dict(formats)
format_tags[0] = tags['name']
format_tags[1] = tags['artists'][0]['name']
format_tags[2] = tags['album']['name']
format_tags[3] = tags['artists'][0]['name']
format_tags[4] = tags['genre']
format_tags[5] = tags['disc_number']
format_tags[6] = tags['duration']
format_tags[7] = tags['year']
format_tags[8] = tags['release_date']
format_tags[9] = tags['track_number']
format_tags[10] = tags['total_tracks']
format_tags[11] = tags['external_ids']['isrc']
for x in formats:
file_format = file_format.replace('{' + formats[x] + '}',
str(format_tags[x]))
if const.args.no_spaces:
file_format = file_format.replace(' ', '_')
return file_format
def sanitize_title(title):
""" Generate filename of the song to be downloaded. """
title = title.replace(' ', '_')
title = title.replace('/', '_')
# slugify removes any special characters
title = slugify(title, ok='-_()[]{}', lower=False)
title = slugify(title, ok='-_()[]{}\/', lower=False,
spaces=(not const.args.no_spaces))
return title

View File

@@ -64,7 +64,7 @@ class EmbedMetadata:
audiofile['arranger'] = meta_tags['artists'][0]['name']
audiofile['performer'] = meta_tags['artists'][0]['name']
audiofile['website'] = meta_tags['external_urls']['spotify']
audiofile['length'] = str(meta_tags['duration_ms'] / 1000.0)
audiofile['length'] = str(meta_tags['duration'])
if meta_tags['publisher']:
audiofile['encodedby'] = meta_tags['publisher']
if meta_tags['genre']:
@@ -79,9 +79,8 @@ class EmbedMetadata:
# https://github.com/quodlibet/mutagen/blob/master/mutagen/id3/_frames.py
# Each class represents an id3 tag
audiofile = ID3(music_file)
year, *_ = meta_tags['release_date'].split('-')
audiofile['TORY'] = TORY(encoding=3, text=year)
audiofile['TYER'] = TYER(encoding=3, text=year)
audiofile['TORY'] = TORY(encoding=3, text=meta_tags['year'])
audiofile['TYER'] = TYER(encoding=3, text=meta_tags['year'])
audiofile['TPUB'] = TPUB(encoding=3, text=meta_tags['publisher'])
audiofile['COMM'] = COMM(encoding=3, text=meta_tags['external_urls']['spotify'])
if meta_tags['lyrics']:
@@ -131,8 +130,7 @@ class EmbedMetadata:
meta_tags['total_tracks'])]
audiofile[tags['disknumber']] = [(meta_tags['disc_number'], 0)]
audiofile[tags['date']] = meta_tags['release_date']
year, *_ = meta_tags['release_date'].split('-')
audiofile[tags['year']] = year
audiofile[tags['year']] = meta_tags['year']
audiofile[tags['originaldate']] = meta_tags['release_date']
audiofile[tags['comment']] = meta_tags['external_urls']['spotify']
if meta_tags['genre']:

View File

@@ -66,7 +66,10 @@ def generate_metadata(raw_song):
except lyricwikia.LyricsNotFound:
meta_tags['lyrics'] = None
# remove unused clutter when debug meta_tags
# fix clutter
meta_tags['year'], *_ = meta_tags['release_date'].split('-')
meta_tags['duration'] = meta_tags['duration_ms'] / 1000.0
del meta_tags['duration_ms']
del meta_tags['available_markets']
del meta_tags['album']['available_markets']

View File

@@ -69,7 +69,8 @@ def generate_youtube_url(raw_song, meta_tags, tries_remaining=5):
song = raw_song
query['q'] = song
else:
song = internals.generate_songname(meta_tags)
song = '{0} - {1}'.format(meta_tags['artists'][0]['name'],
meta_tags['name'])
query['q'] = song
log.debug('query: {0}'.format(query))
@@ -123,7 +124,7 @@ def generate_youtube_url(raw_song, meta_tags, tries_remaining=5):
the duration_tolerance has reached the max_duration_tolerance
'''
while len(possible_videos_by_duration) == 0:
possible_videos_by_duration = list(filter(lambda x: abs(x['seconds'] - (int(meta_tags['duration_ms'])/1000)) <= duration_tolerance, videos))
possible_videos_by_duration = list(filter(lambda x: abs(x['seconds'] - meta_tags['duration']) <= duration_tolerance, videos))
duration_tolerance += 1
if duration_tolerance > max_duration_tolerance:
log.error("{0} by {1} was not found.\n".format(meta_tags['name'], meta_tags['artists'][0]['name']))

View File

@@ -28,8 +28,7 @@ def check_exists(music_file, raw_song, meta_tags):
os.remove(os.path.join(const.args.folder, song))
continue
# check if any song with similar name is already present in the given folder
file_name = internals.sanitize_title(music_file)
if song.startswith(file_name):
if song.startswith(music_file):
log.debug('Found an already existing song: "{}"'.format(song))
if internals.is_spotify(raw_song):
# check if the already downloaded song has correct metadata
@@ -152,23 +151,24 @@ def grab_single(raw_song, number=None):
songname = content.title
if meta_tags is not None:
refined_songname = internals.generate_songname(meta_tags)
refined_songname = internals.generate_songname(const.args.file_format, meta_tags)
log.debug('Refining songname from "{0}" to "{1}"'.format(songname, refined_songname))
if not refined_songname == ' - ':
songname = refined_songname
else:
log.warning('Could not find metadata')
songname = internals.sanitize_title(songname)
if const.args.dry_run:
return
file_name = internals.sanitize_title(songname)
if not check_exists(file_name, raw_song, meta_tags):
if youtube_tools.download_song(file_name, content):
input_song = file_name + const.args.input_ext
output_song = file_name + const.args.output_ext
if not check_exists(songname, raw_song, meta_tags):
# deal with file formats containing slashes to non-existent directories
songpath = os.path.join(const.args.folder, os.path.dirname(songname))
os.makedirs(songpath, exist_ok=True)
if youtube_tools.download_song(songname, content):
input_song = songname + const.args.input_ext
output_song = songname + const.args.output_ext
print('')
try:
@@ -178,7 +178,7 @@ def grab_single(raw_song, number=None):
encoder = 'avconv' if const.args.avconv else 'ffmpeg'
log.warning('Could not find {0}, skipping conversion'.format(encoder))
const.args.output_ext = const.args.input_ext
output_song = file_name + const.args.output_ext
output_song = songname + const.args.output_ext
if not const.args.input_ext == const.args.output_ext:
os.remove(os.path.join(const.args.folder, input_song))
@@ -186,10 +186,6 @@ def grab_single(raw_song, number=None):
if not const.args.no_metadata and meta_tags is not None:
metadata.embed(os.path.join(const.args.folder, output_song), meta_tags)
if const.args.preserve_spaces and "_" in output_song:
song_path = os.path.join(const.args.folder, output_song.replace('_', ' '))
os.rename(os.path.join(const.args.folder, output_song), song_path)
else:
log.error('No audio streams available')

View File

@@ -4,10 +4,8 @@ import spotdl
def load_defaults():
const.args = handle.get_arguments(to_group=False, raw_args='')
const.args.folder = 'test'
const.args = handle.get_arguments(raw_args='', to_group=False, to_merge=False)
const.args.overwrite = 'skip'
const.args.log_level = handle.logging.DEBUG
spotdl.args = const.args
spotdl.log = const.logzero.setup_logger(formatter=const.formatter,

View File

@@ -1,5 +1,10 @@
from core import const
from core import handle
from core import internals
from core import spotify_tools
from core import youtube_tools
from core import convert
from core import metadata
import spotdl
import loader
@@ -7,12 +12,13 @@ import loader
import os
loader.load_defaults()
internals.filter_path(const.args.folder)
raw_song = "Tony's Videos VERY SHORT VIDEO 28.10.2016"
def test_youtube_url():
expect_url = 'http://youtube.com/watch?v=qOOcy2-tmbk'
url = spotdl.youtube_tools.generate_youtube_url(raw_song, meta_tags=None)
url = youtube_tools.generate_youtube_url(raw_song, meta_tags=None)
assert url == expect_url
@@ -20,48 +26,43 @@ def test_youtube_title():
global content
global title
expect_title = "Tony's Videos VERY SHORT VIDEO 28.10.2016"
content = spotdl.youtube_tools.go_pafy(raw_song, meta_tags=None)
title = spotdl.youtube_tools.get_youtube_title(content)
content = youtube_tools.go_pafy(raw_song, meta_tags=None)
title = youtube_tools.get_youtube_title(content)
assert title == expect_title
def test_check_exists():
expect_check = False
# prerequisites for determining filename
file_name = spotdl.internals.sanitize_title(title)
global file_name
file_name = internals.sanitize_title(title)
check = spotdl.check_exists(file_name, raw_song, meta_tags=None)
assert check == expect_check
def test_download():
expect_download = True
# prerequisites for determining filename
file_name = spotdl.internals.sanitize_title(title)
download = spotdl.youtube_tools.download_song(file_name, content)
download = youtube_tools.download_song(file_name, content)
assert download == expect_download
def test_convert():
# exit code 0 = success
expect_convert = 0
# prerequisites for determining filename
file_name = spotdl.internals.sanitize_title(title)
expect_converted = 0
global input_song
global output_song
input_song = file_name + const.args.input_ext
output_song = file_name + const.args.output_ext
convert = spotdl.convert.song(input_song, output_song, const.args.folder)
assert convert == expect_convert
converted = convert.song(input_song, output_song, const.args.folder)
assert converted == expect_converted
def test_metadata():
expect_metadata = None
# prerequisites for determining filename
meta_tags = spotdl.spotify_tools.generate_metadata(raw_song)
file_name = spotdl.internals.sanitize_title(title)
meta_tags = spotify_tools.generate_metadata(raw_song)
if meta_tags:
metadata_output = spotdl.metadata.embed(os.path.join(const.args.folder, output_song), meta_tags)
metadata_input = spotdl.metadata.embed(os.path.join(const.args.folder, input_song), meta_tags)
metadata_output = metadata.embed(os.path.join(const.args.folder, output_song), meta_tags)
metadata_input = metadata.embed(os.path.join(const.args.folder, input_song), meta_tags)
else:
metadata_input = None
metadata_output = None
@@ -70,8 +71,6 @@ def test_metadata():
def test_check_exists2():
expect_check = True
# prerequisites for determining filename
file_name = spotdl.internals.sanitize_title(title)
os.remove(os.path.join(const.args.folder, input_song))
check = spotdl.check_exists(file_name, raw_song, meta_tags=None)
os.remove(os.path.join(const.args.folder, output_song))

View File

@@ -1,6 +1,11 @@
from core import const
from core import handle
from core import internals
from core import spotify_tools
from core import youtube_tools
from core import convert
from core import metadata
import spotdl
@@ -8,35 +13,36 @@ import loader
import os
loader.load_defaults()
internals.filter_path(const.args.folder)
raw_song = 'http://open.spotify.com/track/0JlS7BXXD07hRmevDnbPDU'
def test_spotify_title():
expect_title = 'David André Østby - Intro'
global meta_tags
meta_tags = spotdl.spotify_tools.generate_metadata(raw_song)
title = spotdl.internals.generate_songname(meta_tags)
meta_tags = spotify_tools.generate_metadata(raw_song)
title = internals.generate_songname(const.args.file_format, meta_tags)
assert title == expect_title
def test_youtube_url():
expect_url = 'http://youtube.com/watch?v=rg1wfcty0BA'
url = spotdl.youtube_tools.generate_youtube_url(raw_song, meta_tags)
url = youtube_tools.generate_youtube_url(raw_song, meta_tags)
assert url == expect_url
def test_youtube_title():
expect_title = 'Intro - David André Østby'
content = spotdl.youtube_tools.go_pafy(raw_song, meta_tags)
title = spotdl.youtube_tools.get_youtube_title(content)
content = youtube_tools.go_pafy(raw_song, meta_tags)
title = youtube_tools.get_youtube_title(content)
assert title == expect_title
def test_check_exists():
expect_check = False
# prerequisites for determining filename
songname = spotdl.internals.generate_songname(meta_tags)
songname = internals.generate_songname(const.args.file_format, meta_tags)
global file_name
file_name = spotdl.internals.sanitize_title(songname)
file_name = internals.sanitize_title(songname)
check = spotdl.check_exists(file_name, raw_song, meta_tags)
assert check == expect_check
@@ -44,35 +50,35 @@ def test_check_exists():
def test_download():
expect_download = True
# prerequisites for determining filename
content = spotdl.youtube_tools.go_pafy(raw_song, meta_tags)
download = spotdl.youtube_tools.download_song(file_name, content)
content = youtube_tools.go_pafy(raw_song, meta_tags)
download = youtube_tools.download_song(file_name, content)
assert download == expect_download
def test_convert():
# exit code 0 = success
expect_convert = 0
expect_converted = 0
# prerequisites for determining filename
global input_song
global output_song
input_song = file_name + spotdl.args.input_ext
output_song = file_name + spotdl.args.output_ext
convert = spotdl.convert.song(input_song, output_song, spotdl.args.folder)
assert convert == expect_convert
input_song = file_name + const.args.input_ext
output_song = file_name + const.args.output_ext
converted = convert.song(input_song, output_song, const.args.folder)
assert converted == expect_converted
def test_metadata():
expect_metadata = True
# prerequisites for determining filename
metadata_output = spotdl.metadata.embed(os.path.join(spotdl.args.folder, output_song), meta_tags)
metadata_input = spotdl.metadata.embed(os.path.join(spotdl.args.folder, input_song), meta_tags)
metadata_output = metadata.embed(os.path.join(const.args.folder, output_song), meta_tags)
metadata_input = metadata.embed(os.path.join(const.args.folder, input_song), meta_tags)
assert metadata_output == (metadata_input == expect_metadata)
def test_check_exists2():
expect_check = True
# prerequisites for determining filename
os.remove(os.path.join(spotdl.args.folder, input_song))
os.remove(os.path.join(const.args.folder, input_song))
check = spotdl.check_exists(file_name, raw_song, meta_tags)
os.remove(os.path.join(spotdl.args.folder, output_song))
os.remove(os.path.join(const.args.folder, output_song))
assert check == expect_check