Open Source Spotify Client

librespot librespot-python music-streaming python roadmap

Go to file

こうから b4cb86f1e9 Merge pull request #57 from kokarare1212/deepsource-transform-0edb9411 Format code with yapf		2021-08-25 14:28:07 +09:00
.github	Create dependabot.yml	2021-05-28 13:28:59 +09:00
docs	Restyled by prettier-markdown	2021-05-22 01:26:37 +00:00
examples	Format code with yapf	2021-07-07 08:00:26 +00:00
img	[ImgBot] Optimize images	2021-07-20 09:17:00 +00:00
librespot	Format code with yapf	2021-08-25 05:27:21 +00:00
proto	Initial Commit	2021-02-24 08:46:59 +09:00
.deepsource.toml	Add .deepsource.toml	2021-04-09 23:15:34 +00:00
.gitignore	Add player state	2021-02-25 18:22:28 +09:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md	2021-04-06 07:11:20 +09:00
LICENSE.txt	Add LICENSE.txt	2021-05-15 09:04:41 +09:00
README.md	JetBrains is now a sponsor!	2021-07-20 18:19:38 +09:00
ROADMAP.md	Update ROADMAP.md	2021-03-28 16:00:54 +09:00
SECURITY.md	Restyled by prettier-markdown	2021-05-22 01:26:37 +00:00
requirements.txt	Bump requests from 2.25.1 to 2.26.0	2021-07-14 12:11:22 +00:00
setup.py	Update setup.py	2021-07-18 07:32:26 +09:00
sider.yml	Restyled by prettier-yaml	2021-04-09 23:04:49 +00:00

README.md

Librespot-Python

Open Source Spotify Client

About The Project

This project was developed to make the music streaming service Spotify available on any device.

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.

Getting Started

Prerequisites

Python

Installation

Stable Version *still not working.

pip install librespot

Snapshot Version *Recommended

pip install git+https://github.com/kokarare1212/librespot-python

Usage

Get Spotify's OAuth token

from librespot.core import Session


session = Session.Builder() \
    .user_pass("Username", "Password") \
    .create()

aceess_token = session.tokens().get("playlist-read")

Get Music Stream

*Currently, music streaming is supported, but it may cause unintended behavior.

from librespot.core import Session
from librespot.metadata import TrackId
from librespot.player.codecs import VorbisOnlyAudioQuality
from librespot.audio.decoders import AudioQuality

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.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 examples or read this document for detailed specifications.

Debug

To display the debug information, you need to inject the following code at the top of the code.

import logging


logging.basicConfig(level=logging.DEBUG)

Roadmap

Please read ROADMAP.md.

Contributing

Pull requests are welcome.

License

Distributed under the Apache-2.0 License. See LICENSE.txt for more information.

Librespot (Concept)
Librespot-Java (Core)