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

Compact python examples into a notebook #934

Closed
mase-git opened this issue Jan 23, 2023 · 5 comments
Closed

Compact python examples into a notebook #934

mase-git opened this issue Jan 23, 2023 · 5 comments

Comments

@mase-git
Copy link
Contributor

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.

@stephanebruckert
Copy link
Member

@mase-git great idea, would you like to open a PR for it?

@mase-git
Copy link
Contributor Author

Yep, I will do. I am working on it!

@stephanebruckert
Copy link
Member

stephanebruckert commented Jan 25, 2023

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.

@mase-git
Copy link
Contributor Author

Yes, I agree. It is much better to do it in a separate repository.

@stephanebruckert
Copy link
Member

Just created and made you a maintainer of https://github.com/spotipy-dev/spotipy-examples

It will be useful particularly when cleaning up the current repo prior the v3

@mase-git mase-git closed this as completed Feb 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants