Merge pull request #12 from radio-pi/feature/upgrade-to-2022

Feature/upgrade to 2022

Author: fliiiix

.github/workflows/main.yml

@@ -8,17 +8,19 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [3.9, "3.10", 3.11]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install -r requirements-dev.txt
+    - name: Install vlc
+      run: sudo apt-get install -y vlc
     - name: Test with pytest
-      run: py.test tests/
+      run: python -m pytest tests/

.gitignore

@@ -3,4 +3,4 @@ env
 .pytest_cache/
 .tox/
 radiopi.egg-info/
-twistd.pid
+build

README.md

@@ -1,17 +1,16 @@
 Radio PI backend
-==================
-
+================
 
 A simple REST & websocket server to expose a simple API
 to control a music player. Used by a [web client]( https://github.com/radio-pi/python-websocket-backend/blob/master/index.html)
 and an [Android APP]( https://github.com/radio-pi/RadioPi ).
 
 # Production
 
-Please check out these two blog posts:
+Please check out these two tutorials:
 
-  * [General setup]( https://radio-pi.github.io/2016-01-12-setup-a-radio-pi/  )
-  * [Software setup]( https://radio-pi.github.io/2016-01-13-setup-a-radio-pi-software/ )
+  * [General setup]( https://radio-pi.github.io/2022-11-20-setup-a-radio-pi/  )
+  * [Software setup]( https://radio-pi.github.io/2022-11-26-setup-a-radio-pi-software/ )
 
 
 # Development
@@ -27,18 +26,18 @@ pip install -e .
 Run with:
 
 ```
-twistd -ny service.tac
+uvicorn radiopi.main:app --reload
 ```
 
-Checkout the simple web client at [http://localhost:3000](http://localhost:3000)!
+Checkout the simple web client at [http://localhost:8000](http://localhost:8000)!
 
 
 # Testing
 
 To run the test suite you need `tox`.
 
 ```
-tox -e py37
+tox -e py310
 ```
 
 ### curl
@@ -47,15 +46,17 @@ Here are some useful `curl` commands to copy and paste:
 
 
 Play a stream or a file:
-
 ```
-# curl
-curl -H "Content-Type: application/json" -d '{"url":"http://fritz.de/livemp3"}' http://localhost:3000/play
+curl -H "Content-Type: application/json" -d '{"url":"http://fritz.de/livemp3"}' http://localhost:8000/play
 ```
 
 
 Set volume to 100:
+```
+curl -H "Content-Type: application/json" -d '{"volume":"100"}' http://localhost:8000/volume
+```
 
+Stop the stream:
 ```
-curl -H "Content-Type: application/json" -d '{"volume":"100"}' http://localhost:3000/volume
+curl -H "Content-Type: application/json" -X POST http://localhost:8000/stop
 ```

radiopi.service

@@ -5,7 +5,7 @@ After=syslog.target
 [Service]
 Type=simple
 WorkingDirectory=/usr/local/src/radiopi
-ExecStart=/usr/local/src/radiopi/env/bin/twistd --nodaemon --pidfile= -y service.tac
+ExecStart=/usr/local/src/radiopi/env/bin/uvicorn radiopi.main:app --host 0.0.0.0
 StandardOutput=syslog
 StandardError=syslog
 

radiopi/api.py

@@ -5,28 +5,37 @@ class IPlayer:
     __metaclass__ = ABCMeta
 
     @classmethod
-    def version(self): return "1.0"
+    def version(self):
+        return "1.0"
 
     @abstractmethod
-    def play(self, url): raise NotImplementedError
+    def play(self, url):
+        raise NotImplementedError
 
     @abstractmethod
-    def stop(self): raise NotImplementedError
+    def stop(self):
+        raise NotImplementedError
 
     @abstractmethod
-    def get_playing_key(self): raise NotImplementedError
+    def get_playing_key(self):
+        raise NotImplementedError
 
     @abstractmethod
-    def get_volume(self): raise NotImplementedError
+    def get_volume(self):
+        raise NotImplementedError
 
     @abstractmethod
-    def get_title(self): raise NotImplementedError
+    def get_title(self):
+        raise NotImplementedError
 
     @abstractmethod
-    def set_volume(self, volume): raise NotImplementedError
+    def set_volume(self, volume):
+        raise NotImplementedError
 
     @abstractmethod
-    def get_sleep_timer(self): raise NotImplementedError
+    def get_sleep_timer(self):
+        raise NotImplementedError
 
     @abstractmethod
-    def set_sleep_timer(self, timeInMinutes): raise NotImplementedError
+    def set_sleep_timer(self, timeInMinutes):
+        raise NotImplementedError

radiopi/backend/IPlayerInterface.py

@@ -1,11 +1,11 @@
 from .IPlayerInterface import IPlayer
 from mpd import MPDClient, ConnectionError
 
-HOST = 'localhost'
+HOST = "localhost"
 PORT = 6600
 
-class Player(IPlayer):
 
+class Player(IPlayer):
     def __init__(self):
         mclient = MPDClient()
         mclient.connect(HOST, PORT)
@@ -25,7 +25,7 @@ def stop(self):
     def get_volume(self):
         self.__client_alive()
         statusDICT = self.client.status()
-        vol = statusDICT.get('volume')
+        vol = statusDICT.get("volume")
         return vol
 
     def set_volume(self, volume):

radiopi/backend/MusicPlayerDaemon.py

@@ -9,7 +9,6 @@
 
 
 class Player(IPlayer):
-
     def __init__(self):
         self.instance = vlc.Instance("--no-xlib")
         self.player = self.instance.media_player_new()
@@ -31,20 +30,20 @@ def get_playing_key(self):
         return url
 
     def get_title(self):
-        title = ''
+        title = ""
         if not self.player.get_media():
             return title
 
         url = self.player.get_media().get_mrl()
 
-        request = urllib2.Request(url, headers={'Icy-MetaData': 1})
+        request = urllib2.Request(url, headers={"Icy-MetaData": 1})
         response = urllib2.urlopen(request)
-        metaint = int(response.headers['icy-metaint'])
+        metaint = int(response.headers["icy-metaint"])
 
         for _ in range(200):
             response.read(metaint)
-            metadata_length = struct.unpack('B', response.read(1))[0] * 16
-            metadata = response.read(metadata_length).rstrip(b'\0')
+            metadata_length = struct.unpack("B", response.read(1))[0] * 16
+            metadata = response.read(metadata_length).rstrip(b"\0")
             metadata = self._decode_metadata(metadata)
 
             m = re.search(r"StreamTitle='([^']*)';", metadata)
@@ -64,7 +63,7 @@ def set_volume(self, volume):
     def set_sleep_timer(self, timeInMinutes):
         """
         Create a new sleep timer. Cancels any existing timers.
-        When set to 0 cancles timers.
+        When set to 0 cancels timers.
         """
         if self.sleep_timer:
             self.sleep_timer.cancel()
@@ -80,10 +79,10 @@ def get_sleep_timer(self):
 
     def _decode_metadata(self, metadata):
         try:
-            metadata = metadata.decode('utf8')
+            metadata = metadata.decode("utf8")
         except UnicodeDecodeError:
             try:
-                metadata = metadata.decode('latin-1')
+                metadata = metadata.decode("latin-1")
             except UnicodeDecodeError:
-                metadata = metadata.decode('utf8', errors='replace')
+                metadata = metadata.decode("utf8", errors="replace")
         return metadata

radiopi/backend/VLCPlayer.py

@@ -2,7 +2,7 @@
 from time import time
 
 
-class Sleep():
+class Sleep:
     def __init__(self, sleepInMinutes, callbackFnc):
         self.__time_in_sec = sleepInMinutes * 60
         self.__callback = callbackFnc