Skip to content

Latest commit

 

History

History
203 lines (133 loc) · 5.9 KB

README.md

File metadata and controls

203 lines (133 loc) · 5.9 KB

Contributors Forks Stargazers Issues MIT License LinkedIn


spotifypl

A simple spotify playlist library
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

A simple spotify playlist library

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • node
  • npm 
    npm install npm@latest -g

Installation

  1. Navigate to the directory of the project you are using it in 
    cd /somePath/ToYourProject
  2. Install from NPM 
    npm install spotifypl

Usage

async spotifypl(playlistId, clientId, clientSecret, [options])

playlistId - The ID of the playlist taken from the URL or returned from getIdFromURL

clientId - The Client ID obtained by registering your application with Spotify

clientSecret - The Client Secret obtained by registering your application with Spotify

options - Currently not used, but coming in the future

Returns: playlistResults - The results from Spotify's API

async spotifypl.validatePublicPlaylistURL(playlistURL, clientId, clientSecret)

playlistURL - The URL of the playlist

clientId - The Client ID obtained by registering your application with Spotify

clientSecret - The Client Secret obtained by registering your application with Spotify

Returns: urlIsValid - Boolean indicating whether or not the URL is a valid playlist URL

async spotifypl.validatePublicPlaylistId(playlistId, clientId, clientSecret)

playlistId - The ID of the playlist taken from the URL or returned from getIdFromURL

clientId - The Client ID obtained by registering your application with Spotify

clientSecret - The Client Secret obtained by registering your application with Spotify

Returns: idIsValid - Boolean indicating whether or not the ID is a valid playlist ID

spotifypl.getIdFromURL(playlistURL)

playlistURL - The URL of the playlist

Returns: playlistId - The ID of the playlist

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Allison Poppe - @alliepoppe - [email protected]

Project Link: https://github.com/acpoppe/spotifypl

Acknowledgements