Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configurable #7

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Configurable #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
761e473
Started Configuration Settings
rockyroer Jul 10, 2019
e2dbe5a
Implemented Number of Songs and Playlist Ordering
rockyroer Jul 10, 2019
5f69755
Started Adding Charts configurability to settings.cfg
rockyroer Jul 11, 2019
88efed6
Started Implementing Using charts_to_create
rockyroer Jul 11, 2019
e5c522b
Reworked ChartData into Billboard Adapter Class
rockyroer Jul 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 87 additions & 62 deletions createbillboardplaylist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,16 +202,38 @@ class BillboardAdapter(object): # pylint: disable=too-few-public-methods
def get_chart_data(cls, chart_id, date=None):
"""Returns the chart data for a given chart and date. If no date is
given, it returns the current week's chart."""
return billboard.ChartData(chart_id, date)

chart_info = {
"rock-songs": ("Rock", "top 50 "),
"r-b-hip-hop-songs": ("R&B/Hip-Hop", "top 50 "),
"dance-club-play-songs": ("Dance/Club Play", "top 50 "),
"pop-songs": ("Pop", "top 40 "),
"hot-100": ("Hot 100", "")
}

chart = billboard.ChartData(chart_id, date)
if date == None:
chart_date = (datetime
.strptime(chart.date, '%Y-%m-%d')
.strftime("%B %d, %Y"))
setattr(chart, "date", chart_date)

setattr(chart, "title", chart_info[chart_id][0])
setattr(chart, "url", "http://www.billboard.com/charts/rock-songs" + chart_id)
setattr(chart, "num_songs_phrase", chart_info[chart_id][1])

return chart


class PlaylistCreator(object):
"""This class contains the logic needed to retrieve Billboard charts and
create playlists from them."""
def __init__(self, logger, youtube, billboard_adapter):
def __init__(self, logger, youtube, billboard_adapter, config):
self.logger = logger
self.youtube = youtube
self.billboard = billboard_adapter
self.playlist_ordering = config['playlist_ordering']
self.max_number_of_songs = int(config['max_number_of_songs'])

def add_first_video_to_playlist(self, pl_id, search_query):
"""Does a search for videos and adds the first result to the given
Expand All @@ -232,7 +254,7 @@ def add_chart_entries_to_playlist(self, pl_id, entries):
song_count = 0
for entry in entries:
song_count += 1
if song_count > 100:
if song_count > self.max_number_of_songs:
break

query = entry.artist + ' ' + entry.title
Expand All @@ -244,21 +266,31 @@ def add_chart_entries_to_playlist(self, pl_id, entries):

self.logger.info("\n---\n")

def create_playlist_from_chart(self, chart_id, chart_name,
num_songs_phrase, web_url):
def create_playlist_from_chart(self, chart_id):
"""Create and populate a new playlist with the current Billboard chart
with the given ID"""
# Get the songs from the Billboard web page
chart = self.billboard.get_chart_data(chart_id)
chart_date = (datetime
.strptime(chart.date, '%Y-%m-%d')
.strftime("%B %d, %Y"))

# Create list of max_number_of_songs length in correct order
if self.playlist_ordering == "ASCENDING":
entries = chart.entries[0:self.max_number_of_songs]
elif self.playlist_ordering == "DESCENDING":
entries = chart.entries[0:self.max_number_of_songs][::-1]
else:
entries = chart.entries[0:self.max_number_of_songs]

print("\nAttempting to create {} playlist with the entries:".format(chart_id))
for entry in entries:
print entry.rank, entry.artist, entry.title

# Create a new playlist, if it doesn't already exist
pl_title = "{0} - {1}".format(chart_name, chart_date)
pl_description = ("This playlist contains the " + num_songs_phrase +
"songs in the " + chart_name + " Songs chart for "
"the week of " + chart_date + ". " + web_url)
pl_title = "{0} - {1}".format(chart.title, chart.date)
pl_description = ("This playlist contains the "
+ chart.num_songs_phrase + "songs in the "
+ chart.title + " Songs chart "
+ "for the week of " + chart.date + ". "
+ chart.url)

# Check for an existing playlist with the same title
if self.youtube.playlist_exists_with_title(pl_title):
Expand All @@ -269,63 +301,27 @@ def create_playlist_from_chart(self, chart_id, chart_name,
return

pl_id = self.youtube.create_new_playlist(pl_title, pl_description)
self.add_chart_entries_to_playlist(pl_id, chart.entries)
self.add_chart_entries_to_playlist(pl_id, entries)
return

def create_all(self):
def create_all(self, charts_to_create):
"""Create all of the default playlists with this week's Billboard
charts."""
self.logger.info("### Script started at %s ###\n", time.strftime("%c"))

# Billboard Rock Songs
self.create_playlist_from_chart(
"rock-songs",
"Rock",
"top 50 ",
"http://www.billboard.com/charts/rock-songs",
)

# Billboard R&B/Hip-Hop Songs
self.create_playlist_from_chart(
"r-b-hip-hop-songs",
"R&B/Hip-Hop",
"top 50 ",
"http://www.billboard.com/charts/r-b-hip-hop-songs",
)

# Billboard Dance/Club Play Songs
self.create_playlist_from_chart(
"dance-club-play-songs",
"Dance/Club Play",
"top 50 ",
"http://www.billboard.com/charts/dance-club-play-songs",
)

# Billboard Pop Songs
self.create_playlist_from_chart(
"pop-songs",
"Pop",
"top 40 ",
"http://www.billboard.com/charts/pop-songs",
)

# Billboard Hot 100
self.create_playlist_from_chart(
"hot-100",
"Hot 100",
"",
"http://www.billboard.com/charts/hot-100",
)


for chart_id in charts_to_create:
self.create_playlist_from_chart(chart_id)

self.logger.info("### Script finished at %s ###\n",
time.strftime("%c"))


def load_config(logger):
"""Loads config values from the settings.cfg file in the script dir"""
config_path = get_script_dir() + 'settings.cfg'
section_name = 'accounts'
config_values = {}

# Do basic checks on the config file
if not os.path.exists(config_path):
logger.error("Error: No config file found. Copy settings-example.cfg "
"to settings.cfg and customize it.")
Expand All @@ -334,7 +330,7 @@ def load_config(logger):
config = SafeConfigParser()
config.read(config_path)

# Do basic checks on the config file
section_name = 'accounts'
if not config.has_section(section_name):
logger.error("Error: The config file doesn't have an accounts "
"section. Check the config file format.")
Expand All @@ -345,9 +341,37 @@ def load_config(logger):
"Check the config file values.")
exit()

config_values = {
'api_key': config.get(section_name, 'api_key'),
}
config_values['api_key'] = config.get(section_name, 'api_key')

section_name = 'settings'
if not config.has_section(section_name):
logger.error("Error: The config file doesn't have an settings "
"section. Check the config file format.")
exit()

if not config.has_option(section_name, 'max_number_of_songs'):
logger.error("Error: The max_number_of_songs value is missing: "
"Check the config file values.")
exit()
config_values['max_number_of_songs'] = config.get(section_name, 'max_number_of_songs')

if not config.has_option(section_name, 'playlist_ordering'):
logger.error("Error: The playlist_ordering value is missing: "
"Check the config file values.")
exit()
config_values['playlist_ordering'] = config.get(section_name, 'playlist_ordering')

section_name = 'charts'
if not config.has_section(section_name):
logger.error("Error: The config file doesn't have an charts "
"section. Check the config file format.")
exit()

if not config.has_option(section_name, 'charts_to_create'):
logger.error("Error: The charts_to_create value is missing: "
"Check the config file values.")
exit()
config_values['charts_to_create'] = config.get(section_name, 'charts_to_create').strip('[]').translate(None, '\" ').split(',')

return config_values

Expand All @@ -364,11 +388,12 @@ def main():
logger.setLevel(logging.INFO)

config = load_config(logger)

youtube = YoutubeAdapter(logger, config['api_key'], get_script_dir())
billboard_adapter = BillboardAdapter()

playlist_creator = PlaylistCreator(logger, youtube, billboard_adapter)
playlist_creator.create_all()
playlist_creator = PlaylistCreator(logger, youtube, billboard_adapter, config)
playlist_creator.create_all(config['charts_to_create'])


if __name__ == '__main__':
Expand Down
14 changes: 14 additions & 0 deletions settings-example.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,18 @@
# The default key is not valid, but looks similar to a valid key
api_key = BOzaTrDFLxICpI9ReyXiK3cVy9X2NYhcLz3gqTn

[settings]
# The number of songs for each play list.
# Should be an integer greater than 0.
# Enter a large number (e.g. 200) if you want all songs downloaded for any chart.
max_number_of_songs = 5

# The ordering of videos in playlists should be ASCENDING or DESCENDING
playlist_ordering = ASCENDING

[charts]
# Put in a list the charts that you would like to create playlists for.
# The available charts are: "hot-100", "billboard-200", "pop-songs", "rock-songs", "latin-songs", "r-b-hip-hop-songs", "dance-electronic-songs", "country-songs", "greatest-hot-100-singles", "hot-holiday-songs", "christian-songs","japan-hot-100", "summer-songs",
# Try it with any chart of songs by taking the last part of the url of the charts page:
# e.g. https://www.billboard.com/charts/streaming-songs --> "streaming-songs"
charts_to_create = ["rock-songs","r-b-hip-hop-songs"]