splotify package

Subpackages

• splotify.plots package
  • Submodules
  • splotify.plots.audiofeatures module
    • AudioFeaturesPlot
      • AudioFeaturesPlot.add_features()
      • AudioFeaturesPlot.box_plot()
      • AudioFeaturesPlot.get_features()
      • AudioFeaturesPlot.histogram()
      • AudioFeaturesPlot.scatter_plot_2d()
      • AudioFeaturesPlot.scatter_plot_2d_average()
      • AudioFeaturesPlot.scatter_plot_3d()
      • AudioFeaturesPlot.scatter_plot_3d_average()
      • AudioFeaturesPlot.select_features()
  • splotify.plots.category module
    • CategoryPlot
      • CategoryPlot.bar_chart()
      • CategoryPlot.pie_chart()
  • splotify.plots.popularity module
    • PopularityPlot
      • PopularityPlot.album_bar_chart()
      • PopularityPlot.track_bar_chart()
  • Module contents
• splotify.tests package
  • Submodules
  • splotify.tests.conftest module
    • track_data()
  • splotify.tests.test_audiofeatures module
    • afp()
    • test_box_plot()
    • test_histogram()
    • test_scatter_plot_2d()
    • test_scatter_plot_2d_average()
    • test_scatter_plot_3d()
    • test_scatter_plot_3d_average()
    • test_select_features()
    • vcr_cassette_dir()
  • splotify.tests.test_category module
    • cp()
    • test_bar_chart()
    • test_pie_chart()
  • splotify.tests.test_data module
    • test_add_albums()
    • test_add_playlists()
    • test_add_tracks()
    • vcr_cassette_dir()
  • splotify.tests.test_helpers module
    • test_my_id()
    • test_search_id()
    • vcr_cassette_dir()
  • splotify.tests.test_integration module
    • test_integration()
    • vcr_cassette_dir()
  • splotify.tests.test_popularity module
    • pp()
    • test_album_bar_chart()
    • test_track_bar_chart()
    • vcr_cassette_dir()
  • Module contents

Submodules

splotify.data module

Data class.

This module contains the Data class that stores the tracks you want to plot.

class splotify.data.Data(sp)

Bases: object

Object to store the tracks you want to plot.

Add all the tracks you want to view together in a single plot to a Data instance.

Parameters:

sp (splotify.spotifyapi.SpotifyApi) – A SpotifyApi instance.

add_album(id)

Adds all the tracks on a single album to a Data instance.

Parameters:

id (str) – The URI of the album you want to add. Supports Spotify URIs, Spotify URLs, and Spotify IDs.

add_albums(ids)

Adds all the tracks on multiple albums to a Data instance.

Parameters:

ids (list of str) – The URIs of the albums you want to add. Supports Spotify URIs, Spotify URLs, and Spotify IDs.

add_playlist(id)

Adds the tracks on a single playlist to a Data instance.

Only adds the most recently added 100 songs of a playlist.

Parameters:

id (str) – The URI of the playlist you want to add. Supports Spotify URIs, Spotify URLs, and Spotify IDs.

add_playlists(ids)

Adds the tracks on multiple playlists to a Data instance.

Only adds the most recently added 100 songs of a playlist.

Parameters:

ids (list of str) – The URIs of the playlists you want to add. Supports Spotify URIs, Spotify URLs, and Spotify IDs.

add_track(id)

Adds a single track to a Data instance.

Parameters:

id (str) – The URI of the track you want to add. Supports Spotify URIs, Spotify URLs, and Spotify IDs.

add_tracks(ids)

Adds multiple tracks to a Data instance.

Parameters:

ids (list of str) – The URIs of the tracks you want to add. Supports Spotify URIs, Spotify URLs, and Spotify IDs.

get_data()

Returns all the tracks in a Data instance as a Pandas Dataframe

The returned Dataframe should be passed in while initializing the plot classes, not the Data object itself.

Returns:

A Pandas Dataframe containing the track data added to the Data instance with the columns [“name”, “artist”, “album”, “uri”].

splotify.helpers module

URI search functions.

This module contains functions to help get the Spotify URIs of tracks, albums, artists, and playlists.

splotify.helpers.my_id(sp, limit=10, type='playlist')

Returns and prints the URIs of your personal Spotify playlists.

Parameters:

• sp (splotify.spotifyapi.SpotifyApi) – A SpotifyApi instance.

• limit (int, optional) – The number of results you want to view. Defaults to 10.

• type (str, optional) – The type of URI you want to search up. Defaults to ‘playlist’. Currently only supports ‘playlist’.

Returns:

A nested list. The first list is the names of the columns, and the remaining lists are the search results.

splotify.helpers.search_id(sp, query, limit=10, type='track')

Returns and prints the URIs of public Spotify data.

Returns and prints the URIs of Spotify data that is not user-specific such as tracks, albums, artists, and public playlists.

Parameters:

• sp (splotify.spotifyapi.SpotifyApi) – A SpotifyApi instance.

• query (str) – The query you want to search for.

• limit (int, optional) – The number of results you want to view. Defaults to 10.

• type (str, optional) – The type of URI you want to search up. Currently only supports ‘track’, ‘album’, ‘artist’, and ‘playlist’. Defaults to ‘track’.

Returns:

A nested list. The first list is the names of the columns, and the remaining lists are the search results.

splotify.spotifyapi module

SpotifyApi class.

This module contains the SpotifyApi class that interacts with the Spotify Web API to fetch your Spotify data.

class splotify.spotifyapi.SpotifyApi(client_id, client_secret, redirect_uri)

Bases: object

Object to fetch Spotify data.

Interacts with the Spotify Web API to fetch your Spotify data. When initialized for the first time, you will need to paste in the URI you were directed to. This SpotifyAPI object is passed into various functions that need to access Spotify data.

Parameters:

• client_id (str) – SPOTIPY_CLIENT_ID from Spotify developer app you created.

• client_secret (str) – SPOTIPY_CLIENT_SECRET from Spotify developer app you created.

• redirect_uri (str) – SPOTIPY_REDIRECT_URI from Spotify developer app you created.

album(id)

audio_features(id)

current_user_playlists()

playlist(id)

search(query, limit, type)

track(id)

Module contents