You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
No, it is a feature to organize examples scripts in a more efficient way according to my point of view.
Describe the solution you'd like
Actually, examples folder is a list of scripts that test some functions of Spotipy. I think that there is not an actual intuitive 1:1 direct reference between implemented functions and its application. A possible solution is a compact and well-formatted examples snippets into a jupyter notebook. It can also provide an initial index where you can find the a sections descriptions and find easily the function application needed using internal links (anchors in html would be enough).
Describe alternatives you've considered
The notebook could also be divided into different files, we can arrange functions according to the type of information we want to retrieve (tracks, artists, profiles...). However, I think that this alternative solution is a bit hard to do, caused by the multiple usages of a single function type (for instance: the search function can be used to retrieves a lot of different information).
Additional context
We can use an initial table of contents for a better navigation over the notebook. So, each example can be directly referred by an internal link.
The text was updated successfully, but these errors were encountered:
I was thinking we could even have a separate repository for it in https://github.com/spotipy-dev, eg. spotipy-examples
It would contain the current examples as well as notebooks. Let me know if you think that would be cleaner.
Is your feature request related to a problem? Please describe.
No, it is a feature to organize examples scripts in a more efficient way according to my point of view.
Describe the solution you'd like
Actually, examples folder is a list of scripts that test some functions of Spotipy. I think that there is not an actual intuitive 1:1 direct reference between implemented functions and its application. A possible solution is a compact and well-formatted examples snippets into a jupyter notebook. It can also provide an initial index where you can find the a sections descriptions and find easily the function application needed using internal links (anchors in html would be enough).
Describe alternatives you've considered
The notebook could also be divided into different files, we can arrange functions according to the type of information we want to retrieve (tracks, artists, profiles...). However, I think that this alternative solution is a bit hard to do, caused by the multiple usages of a single function type (for instance: the search function can be used to retrieves a lot of different information).
Additional context
We can use an initial table of contents for a better navigation over the notebook. So, each example can be directly referred by an internal link.
The text was updated successfully, but these errors were encountered: