amcquade / fresh_script Goto Github PK

Find Spotify tracks posted to the HipHopHeads subreddit and add them to a Spotify playlist.

License: MIT License

Python 79.08% HTML 18.82% CSS 2.11%

beginner flask good-first-issue help-wanted hiphop hiphopheads hiphopheads-subreddit music playlist python reddit reddit-crawler script spotify spotipy up-for-grabs web

fresh_script's People

Contributors

Stargazers

Watchers

Forkers

joaoppc groovychoons luizpericolo tonydelanuez sohilnandu jb-delafosse ondkloss gargi amirgi73 ragnoroct adamfitzgibbon jessica3oreno rzhang606 rajesh1993 alan-llin orbville hadshah indus5 slammer23 matthiashunt raymondng0054 nimishverma ianpittwood sallyasd khaledaltuwaijri johncheng2011 ryan-rozario ioluwayo saratrajput pricebenjamin kevinunger gajrajgchouhan kushan2018 kennethnero harsimranvirk grug7 modestchaos emzee831 tduong10101 lambduhh chirag175 lywc20 tekgeek88 sanketkhobragade btcradio johnblanco gary510 roopeshvs vartikably jod35 ahlraf gazarack hbsa05 samarsehgal michaeltetteh hndrkdrga acfrank-24 skandakumaran samuel-stjean happylife2 caldoconpapa

fresh_script's Issues

Fresh Script and Flask feature discussion

I want to leave this issue open for anyone to make suggestions or comment on the new flask implementation of the project.

Add tracks to multiple playlists

move getToken to appropriate location

The User class was moved in #13 but getToken() remains in fresh_script.py. GetToken needs to be either a member function of the User class or refactored and put in the constructor.

Consider using environment variables for sensitive information

Storing config information (API keys, passwords, etc.) could be troublesome if they're just plaintext on a .ini file. Maybe environment variables would be better - use os.environ.get() to fetch them and just check if they're None.

add cron how-to to readmd

Write up instructions as to how a user might run this script as a cron job on a unix system.

set up logging for flask

when the server is running, it should write its outputs to a log file. research how this is done.

max tracks size

i think there is a limit to how many songs you can add to a playlist in a single request. something should be checking the size of the tracks to make sure it doesnt exceed the limit or somehow create another tracks array to be submitted in an additional request.

add to readme: using the pipfile

add arguments section to read me

you can now pass arguments to the script, instructions on how to use those need to go in the readme

Sort tracks by new, hot, both, or all

add all sorting methods the api has to offer

add tracks to multiple playlists

playlist management

give the users ability to add/remove/list the playlists they are submitting tracks to. the easiest way i can think of is by using command arguments, but a menu or something interactive might work better.

Support for adding albums

User should have a choice whether they want to include albums in the set of songs they are adding.

Consolidate configuration to a single file

Currently, fresh.py reads from three separate configuration files: .config.ini, credentials.json, and praw.ini.

To make initialization easier for new users, I propose we expect a single configuration file, config.ini (no longer hidden), with the following structure:

[spotify]
username = <username>
client_id = <client_id>
client_secret = <client_secret>
redirect_uri = <redirect_uri>

[reddit]
username = <username>
client_id = <client_id>
client_secret = <client_secret>

Note that we request the reddit username as well. This allows us to create a user-agent string that better follows the reddit API rules. (Better user-agent strings will be requested in a separate issue.)

output track info for unverified spotify posts

clean up the way the arguments are displayed when given the -h option

Search track titles to add only [FRESH] tagged tracks

command line argument --fresh

All cards open when clicked

When track results are returned and one of the results is clicked, all of the other cards open too

cron examples

add one or two more examples to the readme of running the script as cron with arguments

Post upvote threshold option

supply a parameter to only add songs that meet a minimum up vote threshold

Use cutie for menus

found this really cool menu/user input package cutie and would like to use this for use for things like managing playlists and other things.

Display number of new songs added

`praw.Reddit` instance does not use a unique user-agent

The reddit API rules ask that the supplied user-agent string be

unique and descriptive, including the target platform, a unique application identifier, a version string, and your username as contact information, in the following format:
<platform>:<app ID>:<version string> (by /u/<reddit username>)

Currently, all fresh_script users have the same user-agent, defined by the createPrawConfig function:

fresh_script/fresh.py

Lines 56 to 60 in 29a482a

    
           r_config['bot1'] = { 
        
               'client_id': client_id, 
        
               'client_secret': client_secret, 
        
               'user_agent': 'FreshScript' 
        
           }

The createPrawConfig function creates a site_name called 'bot1' in a local praw.ini file. This site_name is then used to create a praw.Reddit instance within main:

fresh_script/fresh.py

Line 377 in 29a482a

reddit = praw.Reddit('bot1')

One solution would be to override the user_agent string when creating the praw.Reddit instance:

user_agent = ' '.join([
    "Python3:FreshScript:(commit 29a482a)",
    "(by /u/<reddit_user>)",
    "(https://github.com/amcquade/fresh_script)"
])
reddit = praw.Reddit('bot1', user_agent=user_agent)

A helper function to generate the user string would be useful. We would also need to store the user's reddit username in one of the configuration files (see #62).

	r_config['bot1'] = {
	'client_id': client_id,
	'client_secret': client_secret,
	'user_agent': 'FreshScript'
	}