Enhncements: Updated installation instructions, added test script, refactoring and example function #988
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Refactor code to adhere to PEP8 style guide and maintain consistency in the use of double quotes. Defined variables using clear and concise names that follow standard Python naming conventions.
Rewrote Installation section with instructions on installing spotipy on windows, macOS, and linux systems. Added User Guide section detailing use on features such as retrieving user data and searching for music. Added Troubleshooting section detailing some common problems encountered and suggested fixes.
Removed User Guide section
fixed linux install guide
test for search queries displayed in a tabular form generates xml file as artifact
changed folder
Added function to retrieve related artists
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello! I'm a student working on this project as part of my coursework. I've made several changes and additions based on the requirements. Here's a summary of my changes:
Installation Instructions: I have updated the installation instructions in the index.rst file to provide clearer and more detailed steps for setting up the project on different operating systems.
Test Script: I've added a new test script, "test_search.py", which includes unit tests for a core functionality of the project. These tests cover edge cases and ensure the reliability of the code.
Code Refactoring: As part of my documentation efforts, I refactored some of the code in 'setup.py' for improved readability and adherence to best practices. The changes include renaming variables and adding comments.
Added Function: I've also added a new function, "get_related_artists()", in "artist_recommendations.py". This function can serve as a reference for other contributors and users of the project.
I've tested the changes locally to ensure they work as intended and have updated the documentation accordingly. I'm confident that these updates will enhance the project's usability and maintainability. Please let me know if you have any feedback or suggestions. Thank you!