diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b734b3c..061bea0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,10 +5,17 @@ If you would like to contribute to spotipy follow these steps: ### Export the needed environment variables ```bash +# Linux or Mac export SPOTIPY_CLIENT_ID=client_id_here export SPOTIPY_CLIENT_SECRET=client_secret_here export SPOTIPY_CLIENT_USERNAME=client_username_here # This is actually an id not spotify display name export SPOTIPY_REDIRECT_URI=http://localhost:8080 # Make url is set in app you created to get your ID and SECRET + +# Windows +$env:SPOTIPY_CLIENT_ID="client_id_here" +$env:SPOTIPY_CLIENT_SECRET="client_secret_here" +$env:SPOTIPY_CLIENT_USERNAME="client_username_here" +$env:SPOTIPY_REDIRECT_URI="http://localhost:8080" ``` ### Create virtual environment, install dependencies, run tests: diff --git a/docs/index.rst b/docs/index.rst index e4b1d75..33cb749 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -132,7 +132,7 @@ class SpotifyOAuth that can be used to authenticate requests like so:: print(idx, track['artists'][0]['name'], " – ", track['name']) or if you are reluctant to immortalize your app credentials in your source code, -you can set environment variables like so (use ``SET`` instead of ``export`` +you can set environment variables like so (use ``$env:"credentials"`` instead of ``export`` on Windows):: export SPOTIPY_CLIENT_ID='your-spotify-client-id'