[PR #988] [CLOSED] Enhncements: Updated installation instructions, added test script, refactoring and example function #1111

New issue

Closed

opened 2026-02-28 00:03:40 +03:00 by kerem · 0 comments

kerem commented

2026-02-28 00:03:40 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/spotipy-dev/spotipy/pull/988
Author: @soman24
Created: 6/9/2023
Status: ❌ Closed

Base: master ← Head: merged

📝 Commits (10+)

354871d Update setup.py
a8b5662 Update index.rst
85cfcc1 Add files via upload
792b335 Add files via upload
35c0f57 Update index.rst
34d51db Update index.rst
ab64b92 Delete docs/_static directory
d0ef320 Delete docs/_sources directory
7c99847 Delete genindex.html
53372a8 Delete index.html

📊 Changes

4 files changed (+150 additions, -31 deletions)

View changed files

📝 docs/index.rst (+75 -13)
📝 examples/artist_recommendations.py (+6 -0)
📝 setup.py (+24 -18)
➕ tests/unit/test_search.py (+45 -0)

📄 Description

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!

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/spotipy-dev/spotipy/pull/988 **Author:** [@soman24](https://github.com/soman24) **Created:** 6/9/2023 **Status:** ❌ Closed **Base:** `master` ← **Head:** `merged` --- ### 📝 Commits (10+) - [`354871d`](https://github.com/spotipy-dev/spotipy/commit/354871d7bc132a32a6905e668f4c4c5c881a4213) Update setup.py - [`a8b5662`](https://github.com/spotipy-dev/spotipy/commit/a8b566201bad854cfee0c120962025d74e727cbb) Update index.rst - [`85cfcc1`](https://github.com/spotipy-dev/spotipy/commit/85cfcc1a2dda1e1dc29f9bab5809bd1c61828c0b) Add files via upload - [`792b335`](https://github.com/spotipy-dev/spotipy/commit/792b335a220b435cf0b79b620bb11c6da21303c0) Add files via upload - [`35c0f57`](https://github.com/spotipy-dev/spotipy/commit/35c0f57112b66f488360ba578eefa032731e5d7e) Update index.rst - [`34d51db`](https://github.com/spotipy-dev/spotipy/commit/34d51db0517bc844f663f96f1ec4573780ca238d) Update index.rst - [`ab64b92`](https://github.com/spotipy-dev/spotipy/commit/ab64b92fba2ac36f3aff528615f3103f82be3b3f) Delete docs/_static directory - [`d0ef320`](https://github.com/spotipy-dev/spotipy/commit/d0ef32012cb8942ddbd622e8ce9dc510db833d99) Delete docs/_sources directory - [`7c99847`](https://github.com/spotipy-dev/spotipy/commit/7c9984789d8f14518898cbfafb3868a3ae5cb2ac) Delete genindex.html - [`53372a8`](https://github.com/spotipy-dev/spotipy/commit/53372a838d9595c8a5e4660e0bbed8699bd41af9) Delete index.html ### 📊 Changes **4 files changed** (+150 additions, -31 deletions) <details> <summary>View changed files</summary> 📝 `docs/index.rst` (+75 -13) 📝 `examples/artist_recommendations.py` (+6 -0) 📝 `setup.py` (+24 -18) ➕ `tests/unit/test_search.py` (+45 -0) </details> ### 📄 Description 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! --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>