Open Source Spotify Client

librespot librespot-python music-streaming python roadmap

Go to file

碧舞すみほ f28b51b6e6 fix #267		2024-04-21 09:56:52 +09:00
.github	Delete FUNDING.yml	2023-10-25 11:01:09 +09:00
dev	Release 0.0.1	2022-02-09 20:55:27 +09:00
docs	Release 0.0.1	2022-02-09 20:55:27 +09:00
examples	#155 Update example(s)	2022-10-07 18:52:08 +09:00
img	[ImgBot] Optimize images	2021-07-20 09:17:00 +00:00
librespot	fix #267	2024-04-21 09:56:52 +09:00
librespot_player	Separate package	2022-02-09 07:52:14 +09:00
proto	#135 Add ClientToken support	2022-06-28 20:55:10 +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	Update README.md	2023-10-29 21:53:43 +09:00
SECURITY.md	Restyled by prettier-markdown	2021-05-22 01:26:37 +00:00
requirements.txt	Bump pycryptodomex from 3.19.0 to 3.20.0	2024-01-10 12:11:29 +00:00
setup.py	Bump version	2023-05-17 07:00:11 +09:00
sider.yml	Restyled by prettier-yaml	2021-04-09 23:04:49 +00:00

README.md

Librespot-Python

Open Source Spotify Client

Support Project

If you find our project useful and want to support its development, please consider making a donation. Your contribution will help us maintain and improve the project, ensuring that it remains free and accessible to everyone.

About The Project

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

Attention!

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.

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

pip install librespot

Snapshot Version *Recommended

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

Usage

from librespot.zeroconf import ZeroconfServer

zeroconf = ZeroconfServer.Builder().create()

Get Spotify's OAuth token

from librespot.core import Session


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

access_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.audio.decoders import AudioQuality, VorbisOnlyAudioQuality

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.VERY_HIGH), False, None)
# stream.input_stream.stream().read() to get one byte of the music stream.

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)

Contributing

Pull requests are welcome.

License

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

Librespot (Concept)
Librespot-Java (Core)