first commit

README.md

@@ -0,0 +1,106 @@
+# librespot-spotizerr
+
+Open Source Spotify Client
+
+## About The Project
+
+This project is to further add more features for the spotizerr project, forked from [librespot-python](https://github.com/Xoconoch/librespot-spotizerr)
+
+## Note
+
+It is still in the idea stage, so there is a possibility of unintended behavior
+or major specification changes.<br>
+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.<br>
+
+## Getting Started
+
+### Prerequisites
+
+- [Python](https://python.org/)
+
+### Installation
+
+Stable Version
+
+```commandline
+pip install librespot
+```
+
+Snapshot Version \***Recommended**
+
+```commandline
+pip install git+https://github.com/Xoconoch/librespot-spotizerr
+```
+
+## Usage
+
+### Use Zeroconf for Login (no premium required)
+
+```python
+from librespot.zeroconf import ZeroconfServer
+import time
+import logging
+import pathlib
+
+zs = ZeroconfServer.Builder().create()
+logging.warning("Transfer playback from desktop client to librespot-spotizerr via Spotify Connect in order to store session")
+
+while True:
+    time.sleep(1)
+    if zs._ZeroconfServer__session:
+        logging.warning(f"Grabbed {zs._ZeroconfServer__session} for {zs._ZeroconfServer__session.username()}")
+        
+        if pathlib.Path("credentials.json").exists():
+            logging.warning("Session stored in credentials.json. Now you can Ctrl+C")
+            break
+```
+
+### Get Music Stream
+
+*Currently, music streaming is supported, but it may cause unintended behavior.<br>
+
+```python
+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](https://github.com/Xoconoch/librespot-spotizerr/tree/main/examples)
+or read [this document](https://librespot-spotizerr.rtfd.io) for detailed
+specifications.
+
+## Debug
+
+To display the debug information, you need to inject the following code at the
+top of the code.
+
+```python
+import logging
+
+
+logging.basicConfig(level=logging.DEBUG)
+```
+
+## Contributing
+
+Pull requests are welcome.
+
+## License
+
+Distributed under the GPL yada yada, See
+[LICENSE](https://github.com/Xoconoch/librespot-spotizerr/blob/main/LICENSE)
+for more information.
+
+## Related Projects
+
+- [Librespot](https://github.com/librespot-org/librespot) (Concept)
+- [Librespot-Java](https://github.com/librespot-org/librespot-java) (Core)