librespot-python/README.md

45 lines
1.7 KiB
Markdown
Raw Normal View History

2021-02-24 00:46:59 +01:00
![License](https://img.shields.io/github/license/kokarare1212/librespot-python.svg?style=for-the-badge)
![Stars](https://img.shields.io/github/stars/kokarare1212/librespot-python.svg?style=for-the-badge)
![Forks](https://img.shields.io/github/forks/kokarare1212/librespot-python.svg?style=for-the-badge)
# Librespot-Python
2021-02-24 00:44:57 +01:00
Open Source Spotify Client
2021-02-24 00:46:59 +01:00
## About The Project
This project was developed to make the music streaming service Spotify available on any device.
## Note
2021-02-28 03:45:21 +01:00
It is still in the idea stage, so there is a possibility of unintended behavior or major specification changes.
2021-02-24 00:46:59 +01:00
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.
## Getting Started
### Prerequisites
* [Python](https://python.org/)
2021-02-25 22:51:44 +01:00
### Installation
2021-03-28 09:05:00 +02:00
Stable Version **\* still not working.**
2021-02-25 22:51:44 +01:00
```commandline
pip install librespot
```
2021-03-28 09:05:00 +02:00
Snapshot Version **Recommended**
2021-02-25 22:51:44 +01:00
```commandline
pip install git+https://github.com/kokarare1212/librespot-python
```
2021-02-24 00:46:59 +01:00
## Usage
2021-02-25 22:59:13 +01:00
Get Spotify's OAuth token
```python
from librespot.core import Session
session = Session.Builder() \
.user_pass("<Username>", "<Password>") \
.create()
aceess_token = session.tokens().get("playlist-read")
```
Please read [this document](https://librespot-python.rtfd.io) for detailed specifications.
2021-02-24 00:46:59 +01:00
## Roadmap
2021-03-28 08:58:08 +02:00
Please read [ROADMAP.md](https://github.com/kokarare1212/librespot-python/blob/main/ROADMAP.md).
2021-02-24 00:46:59 +01:00
## License
Distributed under the Apache-2.0 License. See `LICENSE.txt` for more information.
## Related Projects
* [Librespot](https://github.com/librespot-org/librespot) (Concept)
* [Librespot-Java](https://github.com/librespot-org/librespot-java) (Core)
## Special thanks
2021-03-28 08:58:08 +02:00
Coming soon