Merge pull request #4 from kamilkosek/dev

Merge 0.1.5 to main

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.4
+current_version = 0.1.5
 commit = True
 tag = True
 

app/__init__.py

@@ -111,8 +111,8 @@ cache = Cache(app)
 # Spotify, Jellyfin, and Spotdl setup
 app.logger.info(f"setting up spotipy")
 sp = spotipy.Spotify(auth_manager=SpotifyClientCredentials(
-    client_id=app.config['SPOTIPY_CLIENT_ID'],
+    client_id=app.config['SPOTIFY_CLIENT_ID'],
-    client_secret=app.config['SPOTIPY_CLIENT_SECRET']
+    client_secret=app.config['SPOTIFY_CLIENT_SECRET']
 ))
 
 app.logger.info(f"setting up jellyfin client")

app/tasks.py

@@ -78,8 +78,8 @@ def download_missing_tracks(self):
                 spotdl_config = app.config['SPOTDL_CONFIG']
                 cookie_file = spotdl_config['cookie_file']
                 output_dir = spotdl_config['output']
-                client_id = app.config['SPOTIPY_CLIENT_ID']
+                client_id = app.config['SPOTIFY_CLIENT_ID']
-                client_secret = app.config['SPOTIPY_CLIENT_SECRET']
+                client_secret = app.config['SPOTIFY_CLIENT_SECRET']
                 search_before_download = app.config['SEARCH_JELLYFIN_BEFORE_DOWNLOAD']
 
                 undownloaded_tracks = Track.query.filter_by(downloaded=False).all()

app/version.py

@@ -1 +1 @@
-__version__ = "0.1.4"
+__version__ = "0.1.5"

config.py

@@ -7,8 +7,8 @@ class Config:
     JELLYFIN_SERVER_URL = os.getenv('JELLYFIN_SERVER_URL')  
     JELLYFIN_ADMIN_USER = os.getenv('JELLYFIN_ADMIN_USER')
     JELLYFIN_ADMIN_PASSWORD = os.getenv('JELLYFIN_ADMIN_PASSWORD')
-    SPOTIPY_CLIENT_ID = os.getenv('SPOTIPY_CLIENT_ID')
+    SPOTIFY_CLIENT_ID = os.getenv('SPOTIFY_CLIENT_ID')
-    SPOTIPY_CLIENT_SECRET = os.getenv('SPOTIPY_CLIENT_SECRET')
+    SPOTIFY_CLIENT_SECRET = os.getenv('SPOTIFY_CLIENT_SECRET')
     JELLYPLIST_DB_HOST = os.getenv('JELLYPLIST_DB_HOST')
     JELLYPLIST_DB_USER = os.getenv('JELLYPLIST_DB_USER')
     JELLYPLIST_DB_PASSWORD = os.getenv('JELLYPLIST_DB_PASSWORD')
@@ -36,8 +36,8 @@ class Config:
             'JELLYFIN_SERVER_URL': cls.JELLYFIN_SERVER_URL,
             'JELLYFIN_ADMIN_USER': cls.JELLYFIN_ADMIN_USER,
             'JELLYFIN_ADMIN_PASSWORD': cls.JELLYFIN_ADMIN_PASSWORD,
-            'SPOTIPY_CLIENT_ID': cls.SPOTIPY_CLIENT_ID,
+            'SPOTIFY_CLIENT_ID': cls.SPOTIFY_CLIENT_ID,
-            'SPOTIPY_CLIENT_SECRET': cls.SPOTIPY_CLIENT_SECRET,
+            'SPOTIFY_CLIENT_SECRET': cls.SPOTIFY_CLIENT_SECRET,
             'JELLYPLIST_DB_HOST' : cls.JELLYPLIST_DB_HOST,
             'JELLYPLIST_DB_USER' : cls.JELLYPLIST_DB_USER,
             'JELLYPLIST_DB_PASSWORD' : cls.JELLYPLIST_DB_PASSWORD,

readme.md

@@ -1,7 +1,7 @@
 ![Jellyplist Logo](./static/images/logo_large.png)
 
 > [!WARNING]  
-> Jellyplist is still at a very early stage: expect Bugs and weird behaviour 
+> Jellyplist is still at a very early stage: expect Bugs and weird behaviour. Especially the UI and UX are a bit clunky and unresponsive
 
 ## What is Jellyplist ? 
 Jellyplist aims to be a companion app for your self-hosted [Jellyfin](https://jellyfin.org/) Server. With Jellyplist you will be able to replicate/sync playlists from Spotify to your local Jellyfin account. Under the hood, it uses [SpotDL](https://spotdl.readthedocs.io/en/latest/) for downloading the corresponding tracks from the available sources if a track isn´t found in your local library.  
@@ -30,8 +30,8 @@ SECRET_KEY = Keykeykesykykesky  # Secret key for session management
 JELLYFIN_SERVER_URL = http://192.168.178.14:8096  # local Jellyfin server
 JELLYFIN_ADMIN_USER = admin # due to api limitations jellyplist uses user authentication rather than api tokens
 JELLYFIN_ADMIN_PASSWORD = admin_password_for_your_jellyifn_admin
-SPOTIPY_CLIENT_ID = <Client ID from Step 1>
+SPOTIFY_CLIENT_ID = <Client ID from Step 1>
-SPOTIPY_CLIENT_SECRET = <Secret from Step 1>
+SPOTIFY_CLIENT_SECRET = <Secret from Step 1>
 JELLYPLIST_DB_HOST = postgres-jellyplist #Hostname of the db Container
 JELLYPLIST_DB_USER = jellyplist
 JELLYPLIST_DB_PASSWORD = jellyplist
@@ -158,7 +158,25 @@ Jellyplist will cache requests where possible. Especially the `/tracks` endpoint
 
 
 - When logged in as admin, you will see the admin section in the sidebar. From there you can some kind of `batch linking`. All unlinked tracks will be displayed at once. 
-> [!TIP]
-> Linking of tracks had to be done only once. If a different playlist has the same track, Jellyplist will reuse the link
  ![Jellyplist batch link](./screenshots/batch_link.png)
 
+> [!TIP]
+> Linking of tracks had to be done only once. If a different playlist has the same track, Jellyplist will reuse the link
+
+
+#### After you added  your first playlist´s, the worker and scheduler will take over from this point. 
+The default schedules are:
+| **Schedule Name**                          | **Task**                                      | **Schedule**         |
+|--------------------------------------------|----------------------------------------------|----------------------|
+| `download-missing-tracks-schedule`         | `app.tasks.download_missing_tracks`          | Every day at minute 30 |
+| `check-playlist-updates-schedule`          | `app.tasks.check_for_playlist_updates`       | Every day at minute 25 |
+| `update_all_playlists_track_status-schedule`| `app.tasks.update_all_playlists_track_status`| Every 2 minutes       |
+| `update_jellyfin_id_for_downloaded_tracks-schedule` | `app.tasks.update_jellyfin_id_for_downloaded_tracks` | Every 10 minutes      |
+
+For now the schedules aren´t configurable, but this is subject to change.
+> [!TIP]
+> Please be patient after you added your first batch of playlists! Jellyplist currently processes one track at a time, and this means it can take some time for you to see the first results. 
+
+Then let Jellyplist do it´s work, after some time you should be able to see the playlist in Jellyfin. 
+
+Have Fun ✌🏽

version.py

@@ -1 +1 @@
-__version__ = "0.1.4"
+__version__ = "0.1.5"