rdelaage
/
librespot-python
mirror of https://github.com/kokarare1212/librespot-python.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update document

This commit is contained in:
こうから 2021-05-17 12:58:04 +09:00
parent 5c63580ce3
commit 07ed23cca1
1 changed files with 40 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
docs/index.md
View File

@ -2,32 +2,54 @@
![](https://img.shields.io/github/stars/kokarare1212/librespot-python.svg)
![](https://img.shields.io/github/forks/kokarare1212/librespot-python.svg)
[![](https://deepsource.io/gh/kokarare1212/librespot-python.svg/?label=active+issues&show_trend=true)](https://deepsource.io/gh/kokarare1212/librespot-python/?ref=repository-badge)
# Get Started
## Contents
* [Supported Futures](supported.md)
* [API Reference](api.md)
## What's librespot-python?
| librespot-python is a python port of Spotify's open source client library [librespot](https://github.com/librespot-org/librespot).
| It was created to play Spotify on various platforms and devices.
librespot-python is a python port of Spotify's open source client library [librespot](https://github.com/librespot-org/librespot).
It was created to play Spotify on various platforms and devices.
## What do you need?
| In order to develop with this library, you need to use Python.
| Python can be downloaded from [the official website here](https://python.org/).
In order to develop with this library, you need to use Python.
Python can be downloaded from [the official website here](https://python.org/).
## Disclaimer
| Please keep in mind that this library is not like Spotify approved.
| Therefore, the worst that can happen is that you will be banned from Spotify.
| Also, please keep in mind that this library is in alpha and may behave in unintended ways.
Please keep in mind that this library is not like Spotify approved.
Therefore, the worst that can happen is that you will be banned from Spotify.
Also, please keep in mind that this library is in alpha and may behave in unintended ways.
## Installation
| You can download this library in the following way.
| Stable Version ***still not working.**
You can download this library in the following way.
Stable Version ***still not working.**
```commandline
pip install librespot
```
| Snapshot Version ***Recommended**
Snapshot Version ***Recommended**
```commandline
pip install git+https://github.com/kokarare1212/librespot-python
```
## Usage
### Get Spotify's OAuth token
```python
from librespot.core import Session
@ -38,8 +60,11 @@ session = Session.Builder() \
aceess_token = session.tokens().get("playlist-read")
```
### Get Music Stream
| *Currently, music streaming is supported, but it may cause unintended behavior.
*Currently, music streaming is supported, but it may cause unintended behavior.
```python
from librespot.core import Session
from librespot.metadata import TrackId
@ -55,8 +80,11 @@ stream = session.content_feeder().load(track_id, VorbisOnlyAudioQuality(AudioQua
# stream.input_stream.stream().read() to get one byte of the music stream.
# ex: 1 (If there is no more voice data, -1 is received as the result.)
```
## Debug
| To display the debug information, you need to inject the following code at the top of the code.
To display the debug information, you need to inject the following code at the top of the code.
```python
import logging