feat:geospatial artist localization editor, including itowns map, and musicBrainz api usage (WIP)

refactored api naming

Author: jgarnierGit

.env

@@ -1,3 +1,5 @@
 MUSIC_LIBRARY_PATH=D:\mp3
 MUSIC_PATH_MAX_LENGTH=500
 PG_DATA=./pgdata
+
+API_HEADER_MAIL=

README.md

@@ -10,6 +10,7 @@ Frontend :
   - App : [Vue3](https://vuejs.org/), [Nuxt3](https://nuxt.com/), [Pinia](https://pinia.vuejs.org/)
   - Component Framework : [Vuetify3](https://vuetifyjs.com/)
   - Music Vizualiser : [projectM](https://github.com/projectM-visualizer/projectm) via [webAssembly](https://webassembly.org/)
+  - Geospatial Map : [Itowns](https://www.itowns-project.org/) and [Threejs](https://threejs.org/)
 
 Backend : 
   - Server : [python3](https://www.python.org/), [Django](https://www.djangoproject.com/), [Nginx](https://nginx.org/)
@@ -21,14 +22,20 @@ Backend :
 
 ## Features 
 
-Navigate through your local music library, play songs in your web browser and enjoy Milkdrop integration.
+ - Music library accessing in readonly mode to your local library
+ - Database persistency with metadata exposition
+ - Geospatial music localizer editor & filtering - WIP  (ne_110m_admin_0_countries)
+ - ProjectM Milkdrop vizualisation
 
 Musics from your fileSystem are saved in the database on the first reach.
 
 For now, music files can be populated with [/filesystem/list](http://localhost:8000/filesystem/list) endpoint.
 
 A checksum is calculated based on music name, artist name and album name, to make the database resilient to filesystem changes.
 
+ - metadata editor (db persistency) :
+   - In addition of reading music file metadata, you can fetch artist country via [musicbrainz](https://musicbrainz.org). If the match has a unique result with a score of 100, it will be saved automatically, otherwise you'll have to check and save.
+
 ## Setup
 
 [Docker](https://www.docker.com/)
@@ -40,6 +47,7 @@ edit .env example before first launch :
  - `MUSIC_LIBRARY_PATH` : path to your music folder
  - `MUSIC_PATH_MAX_LENGTH` : default 500 character, increase that number if your music paths exceed this value, then restart backend.
  - `PG_DATA` : database persistency.
+ - `API_HEADER_MAIL` : mandatory to use properly musicbrainz.org API
 
 ## Start up
 
@@ -52,7 +60,7 @@ edit .env example before first launch :
 - Nginx serving your music filesystem(`http://localhost:8081/music`)
 - database access (`0.0.0.0:54333`)
   - postgres/postgres
-  - database and schema : `music`.`library`
+  - database and schema : `music`.`public`
   - external database manager recommended [DBeaver](https://dbeaver.io/), for as long as I don't provide pgadmin container.
 
 ### Notes

docker-compose.yml

@@ -21,9 +21,13 @@ services:
         read_only: true
       - ./services/backend:/app
       - ./data:/data
+    env_file:
+      - .env
+      - .env.dev
     environment:
       - GDAL_LIBRARY_PATH=/usr/lib/ogdi/4.1/libgdal.so
-      - MUSIC_PATH_MAX_LENGTH=${MUSIC_PATH_MAX_LENGTH}
+      - APP_VERSION=0.1
+      - APP_NAME=web-music-library
     depends_on:
       - db
       - nginx
@@ -38,7 +42,6 @@ services:
       - 54333:5432
     volumes:
       - ${PG_DATA}:/var/lib/postgresql/data
-      - ./services/migration_install.sql:/docker-entrypoint-initdb.d/migration_install.sql
 
   nginx:
     image: nginx:stable-alpine3.19-perl

services/backend/backend-django/appbackend/settings.py

@@ -31,7 +31,7 @@
 # Application definition
 
 INSTALLED_APPS = [
-    "filesystem.apps.FilesystemConfig",
+    "music.apps.MusicConfig",
     "rest_framework",
     "corsheaders",
     "django.contrib.gis",

services/backend/backend-django/appbackend/urls.py

@@ -19,6 +19,6 @@
 from django.urls import include, path
 
 urlpatterns = [
-    path("filesystem/", include("filesystem.urls")),
+    path("api/", include("music.urls")),
     path("admin/", admin.site.urls),
 ]

services/backend/backend-django/filesystem/migrations/0001_initial.py

@@ -0,0 +1,35 @@
+from rest_framework import status
+from rest_framework.response import Response
+from rest_framework.views import APIView
+from ..models import Music, Artist, MusicSerializer, ArtistSerializer
+from django.http import JsonResponse
+
+
+class IncrementMusicPlayedView(APIView):
+    def post(self, request, item_id):
+        try:
+            music = Music.objects.get(id=item_id)
+            music.count_played += 1
+            music.save()
+        except Music.DoesNotExist:
+            return Response(status=status.HTTP_404_NOT_FOUND)
+        return JsonResponse(MusicSerializer(music).data)
+
+
+class ArtistsListView(APIView):
+    def get(self, request):
+        artists = Artist.objects.all()
+        return JsonResponse(
+            {"artists": [ArtistSerializer(artist).data for artist in artists]}
+        )
+
+
+class ArtistUpdateView(APIView):
+    def put(self, request, artist_id):
+        artist = Artist.objects.get(id=artist_id)
+        serializer = ArtistSerializer(artist, data=request.data)
+        if serializer.is_valid():
+            serializer.save()
+            return Response(status=status.HTTP_204_NO_CONTENT)
+        else:
+            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

services/backend/backend-django/filesystem/urls.py

@@ -0,0 +1,32 @@
+import os
+from django.http import HttpResponse, JsonResponse
+from rest_framework.views import APIView
+import musicbrainzngs
+
+MAIL = os.environ.get("API_HEADER_MAIL")
+APP_VERSION = os.environ.get("APP_VERSION")
+APP_NAME = os.environ.get("APP_NAME")
+
+
+def configure_musicbrainz():
+    if not MAIL:
+        return HttpResponse("API header mail is required", status=403)
+
+    musicbrainzngs.set_useragent(APP_NAME, APP_VERSION, contact=MAIL)
+    musicbrainzngs.set_format(fmt="json")
+    musicbrainzngs.set_rate_limit(limit_or_interval=1.0, new_requests=1)
+
+
+class ArtistCountryView(APIView):
+    def get(self, request, artist_name):
+        configure_musicbrainz()
+        # Search for the artist, returning 25 results by default.
+        search_data = musicbrainzngs.search_artists(
+            query=f"artist:{artist_name}", limit=1, offset=None, strict=True
+        )
+        country = (
+            "UNKNOWN"
+            if search_data["count"] == 0
+            else search_data["artists"][0]["country"]
+        )
+        return JsonResponse({"artist_name": artist_name, "country": country})

services/backend/backend-django/filesystem/__init__.py services/backend/backend-django/music/__init__.py

@@ -1,9 +1,6 @@
 import os
 from django.http import JsonResponse
-from rest_framework import status
-from rest_framework.response import Response
-from rest_framework.views import APIView
-from .models import Music, Artist, Album, MusicSerializer
+from ..models import Music, Artist, Album, MusicSerializer
 from uuid import uuid4
 
 MUSIC_PATH = "/music"
@@ -55,14 +52,3 @@ def updateDb(music_name: str, music_path: str, artist_name: str, album_name: str
         music.save()
     existing_music = Music.objects.filter(checksum=music.checksum).first()
     return existing_music
-
-
-class IncrementMusicPlayedView(APIView):
-    def post(self, request, item_id):
-        try:
-            music = Music.objects.get(id=item_id)
-            music.count_played += 1
-            music.save()
-        except Music.DoesNotExist:
-            return Response(status=status.HTTP_404_NOT_FOUND)
-        return JsonResponse(MusicSerializer(music).data)

services/backend/backend-django/filesystem/admin.py services/backend/backend-django/music/admin.py

@@ -1,6 +1,6 @@
 from django.apps import AppConfig
 
 
-class FilesystemConfig(AppConfig):
+class MusicConfig(AppConfig):
     default_auto_field = "django.db.models.BigAutoField"
-    name = "filesystem"
+    name = "music"