update document

This commit is contained in:
こうから
2021-05-17 12:58:04 +09:00
parent 5c63580ce3
commit 07ed23cca1

View File

@@ -2,32 +2,54 @@
![](https://img.shields.io/github/stars/kokarare1212/librespot-python.svg) ![](https://img.shields.io/github/stars/kokarare1212/librespot-python.svg)
![](https://img.shields.io/github/forks/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) [![](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 # Get Started
## Contents ## Contents
* [Supported Futures](supported.md) * [Supported Futures](supported.md)
* [API Reference](api.md) * [API Reference](api.md)
## What's librespot-python? ## 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? ## 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 ## 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. Please keep in mind that this library is not like Spotify approved.
| Also, please keep in mind that this library is in alpha and may behave in unintended ways.
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 ## 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 ```commandline
pip install librespot pip install librespot
``` ```
| Snapshot Version ***Recommended**
Snapshot Version ***Recommended**
```commandline ```commandline
pip install git+https://github.com/kokarare1212/librespot-python pip install git+https://github.com/kokarare1212/librespot-python
``` ```
## Usage ## Usage
### Get Spotify's OAuth token ### Get Spotify's OAuth token
```python ```python
from librespot.core import Session from librespot.core import Session
@@ -38,8 +60,11 @@ session = Session.Builder() \
aceess_token = session.tokens().get("playlist-read") aceess_token = session.tokens().get("playlist-read")
``` ```
### Get Music Stream ### 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 ```python
from librespot.core import Session from librespot.core import Session
from librespot.metadata import TrackId 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. # 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.) # ex: 1 (If there is no more voice data, -1 is received as the result.)
``` ```
## Debug ## 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 ```python
import logging import logging