diff --git a/README.md b/README.md index 6eb2df3..0cfc2a0 100644 --- a/README.md +++ b/README.md @@ -16,17 +16,14 @@ on any device. This repository has been completely rewritten from the transplant.
There may be some functions that are not implemented yet.
-If so, please feel free to open an issue. +If so, please feel free to open an issue.
## Note It is still in the idea stage, so there is a possibility of unintended behavior -or major specification changes. -We **DO NOT** encourage piracy and **DO NOT** support any form of -downloader/recorder designed with the help of this repository and in general -anything that goes against the Spotify ToS. -For other guidelines, please see -[CODE_OF_CONDUCT.md](https://github.com/kokarare1212/librespot-python/blob/main/CODE_OF_CONDUCT.md). +or major specification changes.
+We **DO NOT** encourage piracy and **DO NOT** support any form of downloader/recorder designed with the help of this repository and in general anything that goes against the Spotify ToS.
+For other guidelines, please see [CODE_OF_CONDUCT.md](https://github.com/kokarare1212/librespot-python/blob/main/CODE_OF_CONDUCT.md).
## Getting Started @@ -65,7 +62,7 @@ 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 @@ -73,15 +70,13 @@ from librespot.metadata import TrackId from librespot.player.codecs import VorbisOnlyAudioQuality from librespot.audio.decoders import AudioQuality -session = Session.Builder() - .user_pass("Username", "Password") +session = Session.Builder() \ + .user_pass("Username", "Password") \ .create() track_id = TrackId.from_uri("spotify:track:xxxxxxxxxxxxxxxxxxxxxx") -stream = session.content_feeder().load(track_id, VorbisOnlyAudioQuality(AudioQuality.AudioQuality.VERY_HIGH), False, - None) +stream = session.content_feeder().load(track_id, VorbisOnlyAudioQuality(AudioQuality.AudioQuality.VERY_HIGH), False, None) # 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.) ``` Other uses are @@ -101,11 +96,6 @@ import logging logging.basicConfig(level=logging.DEBUG) ``` -## Roadmap - -Please read -[ROADMAP.md](https://github.com/kokarare1212/librespot-python/blob/main/ROADMAP.md). - ## Contributing Pull requests are welcome. diff --git a/ROADMAP.md b/ROADMAP.md deleted file mode 100644 index 1511271..0000000 --- a/ROADMAP.md +++ /dev/null @@ -1,2 +0,0 @@ -# Roadmap -2021/03/28: **\*Eliminate circular importing.** diff --git a/docs/index.md b/docs/index.md index 0dca5e8..cf85b02 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,29 +14,23 @@ ## 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](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. - +You can download this library in the following way.

Stable Version **\*still not working.** ```commandline @@ -66,7 +60,7 @@ 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 @@ -74,8 +68,8 @@ from librespot.metadata import TrackId from librespot.player.codecs import VorbisOnlyAudioQuality from librespot.audio.decoders import AudioQuality -session = Session.Builder() - .user_pass("Username", "Password") +session = Session.Builder() \ + .user_pass("Username", "Password") \ .create() track_id = TrackId.from_uri("spotify:track:xxxxxxxxxxxxxxxxxxxxxx")