mirror of
https://github.com/spotipy-dev/spotipy.git
synced 2026-06-19 01:03:53 +00:00
Improve usability on README.md (#983)
* Update README.md Improve usability of the README.md file * Update CHANGELOG.md change log following README changes * Update CHANGELOG.md * Update README.md Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Update README.md Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Update README.md Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Update README.md Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Update README.md • Removed the License Section from the table of contents due to the new GitHub tab UI • Updated link to not specify any specific version * Update CHANGELOG.md --------- Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
This commit is contained in:
chaisupt
GitHub
parent
1416d47cba
commit
a14a28e10c
@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
### Changed
|
||||
- Changes the YouTube video link for authentication tutorial (the old video was in low definition, the new one is in high definition)
|
||||
- Updated links to Spotify in documentation
|
||||
- Improve usability on README.md
|
||||
|
||||
## [2.23.0] - 2023-04-07
|
||||
|
||||
|
||||
49
README.md
49
README.md
@ -1,12 +1,26 @@
|
||||
# Spotipy
|
||||
|
||||
##### A light weight Python library for the Spotify Web API
|
||||
##### Spotipy is a lightweight Python library for the [Spotify Web API](https://developer.spotify.com/documentation/web-api). With Spotipy you get full access to all of the music data provided by the Spotify platform.
|
||||
|
||||
 [](https://spotipy.readthedocs.io/en/latest/?badge=latest)
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Features](#features)
|
||||
- [Documentation](#documentation)
|
||||
- [Installation](#installation)
|
||||
- [Quick Start](#quick-start)
|
||||
- [Reporting Issues](#reporting-issues)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
|
||||
## Features
|
||||
|
||||
Spotipy supports all of the features of the Spotify Web API including access to all end points, and support for user authorization. For details on the capabilities you are encouraged to review the [Spotify Web API](https://developer.spotify.com/web-api/) documentation.
|
||||
|
||||
## Documentation
|
||||
|
||||
Spotipy's full documentation is online at [Spotipy Documentation](http://spotipy.readthedocs.org/).
|
||||
Spotipy's [full documentation is online](http://spotipy.readthedocs.org/). Some function may need a [specific scope](https://developer.spotify.com/documentation/web-api/concepts/scopes). If you do not define the scope properly `ERROR 401 Unauthorized, permission missing` may occur.
|
||||
|
||||
## Installation
|
||||
|
||||
@ -30,10 +44,9 @@ pip install spotipy --upgrade
|
||||
|
||||
A full set of examples can be found in the [online documentation](http://spotipy.readthedocs.org/) and in the [Spotipy examples directory](https://github.com/plamere/spotipy/tree/master/examples).
|
||||
|
||||
To get started, install spotipy and create an app on https://developers.spotify.com/.
|
||||
Add your new ID and SECRET to your environment:
|
||||
To get started, [install spotipy](#installation), create a new account or log in on https://developers.spotify.com/. Go to the [dashboard](https://developer.spotify.com/dashboard), create an app and add your new ID and SECRET (ID and SECRET can be found on an app setting) to your environment ([step-by-step video](https://www.youtube.com/watch?v=kaBVN8uP358)):
|
||||
|
||||
### Without user authentication
|
||||
### Example without user authentication
|
||||
|
||||
```python
|
||||
import spotipy
|
||||
@ -46,8 +59,20 @@ results = sp.search(q='weezer', limit=20)
|
||||
for idx, track in enumerate(results['tracks']['items']):
|
||||
print(idx, track['name'])
|
||||
```
|
||||
Expected result:
|
||||
```
|
||||
0 Island In The Sun
|
||||
1 Say It Ain't So
|
||||
2 Buddy Holly
|
||||
.
|
||||
.
|
||||
.
|
||||
18 Troublemaker
|
||||
19 Feels Like Summer
|
||||
```
|
||||
|
||||
### With user authentication
|
||||
|
||||
### Example with user authentication
|
||||
|
||||
A redirect URI must be added to your application at [My Dashboard](https://developer.spotify.com/dashboard/applications) to access user authenticated features.
|
||||
|
||||
@ -65,6 +90,12 @@ for idx, item in enumerate(results['items']):
|
||||
track = item['track']
|
||||
print(idx, track['artists'][0]['name'], " – ", track['name'])
|
||||
```
|
||||
Expected result will be the list of music that you liked. For example if you liked Red and Sunflower, the result will be:
|
||||
```
|
||||
0 Post Malone – Sunflower - Spider-Man: Into the Spider-Verse
|
||||
1 Taylor Swift – Red
|
||||
```
|
||||
|
||||
|
||||
## Reporting Issues
|
||||
|
||||
@ -77,3 +108,9 @@ Don’t forget to add the *Spotipy* tag, and any other relevant tags as well, be
|
||||
If you have suggestions, bugs or other issues specific to this library,
|
||||
file them [here](https://github.com/plamere/spotipy/issues).
|
||||
Or just send a pull request.
|
||||
|
||||
## Contributing
|
||||
|
||||
If you are a developer with Python experience, and you would like to contribute to Spotipy, please be sure to follow the guidelines listed on documentation page
|
||||
|
||||
> #### [Visit the guideline](https://spotipy.readthedocs.io/en/#contribute)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user