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.

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

Update directions in TUTORIAL.md #1101

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

Conversation

brennanpate
Copy link

I encountered a few issues when completing steps in the TUTORIAL.md file. I've added some updates in the directions of this file to more closely match the current layout of Spotify's Developer Dashboard and the process for creating an app.

@dieser-niko dieser-niko linked an issue May 27, 2024 that may be closed by this pull request
CHANGELOG.md Outdated
Comment on lines 10 to 15
### Changed
- Made some updates to TUTORIAL.md to more closely match the current layout of Spotify's Developer Dashboard and the process for creating an app

### Added
- Added directions to install Spotipy in TUTORIAL.md (pip install spotipy --upgrade)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add these points to the already existing headers below.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You did what I asked for, but we've released a new version, so this file got changed once again.

We are already discussing this internally about how we are going forward with the CHANGELOG.md file, as the changes can be automatically gathered by GitHub. So we'll ignore this for now until this is resolved.

TUTORIAL.md Outdated
A. Visit the [Spotify developer portal](https://developer.spotify.com/dashboard/). If you already have a Spotify account, click "Log in" and enter your username and password. Otherwise, click "Sign up" and follow the steps to create an account. After you've signed in or signed up, you should be redirected to your developer dashboard.

B. Click the "Create an App" button. Enter any name and description you'd like for your new app. Accept the terms of service and click "Create."
A. Visit the [Spotify developer portal](https://developer.spotify.com/dashboard/). If you already have a Spotify account, click "Log in" and enter your username and password. If you don't already have a Spotify account, click "Sign up" and follow the steps to create an account. After you've signed in or signed up, begin by clicking Documentation at the top of your screen and then click “Web API”. Finally, click the link in “Log into the dashboard using your Spotify account” to go to Spotify’s Developer Dashboard.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A. Visit the [Spotify developer portal](https://developer.spotify.com/dashboard/). If you already have a Spotify account, click "Log in" and enter your username and password. If you don't already have a Spotify account, click "Sign up" and follow the steps to create an account. After you've signed in or signed up, begin by clicking Documentation at the top of your screen and then click “Web API”. Finally, click the link in “Log into the dashboard using your Spotify account” to go to Spotify’s Developer Dashboard.
A. Visit the [Spotify developer portal](https://developer.spotify.com/dashboard/). If you already have a Spotify account, click "Log in" and enter your username and password. Otherwise, click "Sign up" and follow the steps to create an account. After you've signed in or signed up, begin by clicking on your profile name at the top right of your screen and then click on “Dashboard” to go to Spotify’s Developer Dashboard.

@brennanpate
Copy link
Author

Hello,

I have updated the TUTORIAL.md and CHANGELOG.md files as requested. Please let me know if any other changes are needed or if there are any issues.

Thank you!

Copy link
Member

@dieser-niko dieser-niko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rest looks good.

But I can't let it merge for now because of the CHANGELOG.md file.

TUTORIAL.md Outdated
Comment on lines 12 to 15
A. After ensuring that pip is installed, run the following command in Terminal to install Spotipy: pip install spotipy --upgrade

A. After ensuring that pip is installed, run the following command in Terminal to install Spotipy: pip install spotipy --upgrade

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure how this happened, but it seems that this line is duplicated.

Suggested change
A. After ensuring that pip is installed, run the following command in Terminal to install Spotipy: pip install spotipy --upgrade
A. After ensuring that pip is installed, run the following command in Terminal to install Spotipy: pip install spotipy --upgrade
A. After ensuring that pip is installed, run the following command in Terminal to install Spotipy: pip install spotipy --upgrade

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not your fault, but I have to mention it somewhere. Why do we check if pip is installed and then AFTER we check if Python is installed? I think we could change the order as well.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noted about the duplicate line. I have removed this.

Good callout about the order of pip and Python installation instructions. I have changed the order of these.

It looks like my pull request is failing due to a couple of failed tests in the non_user_endpoints/test.py file. Would you suggest I comment out those tests or do something else? My local repo should be up-to-date with the remote repo, so I'm not quite sure why those tests are failing unless they're also failing for everyone else.

CHANGELOG.md Outdated
Comment on lines 10 to 15
### Changed
- Made some updates to TUTORIAL.md to more closely match the current layout of Spotify's Developer Dashboard and the process for creating an app

### Added
- Added directions to install Spotipy in TUTORIAL.md (pip install spotipy --upgrade)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You did what I asked for, but we've released a new version, so this file got changed once again.

We are already discussing this internally about how we are going forward with the CHANGELOG.md file, as the changes can be automatically gathered by GitHub. So we'll ignore this for now until this is resolved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Directions In TUTORIAL.md
2 participants