SpotDown 0.1.1__tar.gz → 1.3.0__tar.gz

{spotdown-0.1.1 → spotdown-1.3.0}/MANIFEST.in

@@ -1,3 +1,3 @@
-include README.md
-include requirements.txt
-include SpotDown/upload/version.py
+include README.md
+include requirements.txt
+include SpotDown/upload/version.py

{spotdown-0.1.1/SpotDown.egg-info → spotdown-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: SpotDown
-Version: 0.1.1
+Version: 1.3.0
 Summary: A command-line program to download music
 Home-page: https://github.com/Arrowar/spotdown
 Author: Arrowar
@@ -13,12 +13,12 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: rich
 Requires-Dist: httpx
-Requires-Dist: playwright
 Requires-Dist: unidecode
 Requires-Dist: ua-generator
 Requires-Dist: unidecode
 Requires-Dist: yt-dlp
 Requires-Dist: Pillow
+Requires-Dist: spotipy
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -41,6 +41,7 @@ Dynamic: summary
 ## 💝 Support the Project
 
 [![Donate PayPal](https://img.shields.io/badge/💳_Donate-PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white&labelColor=2d3748)](https://www.paypal.com/donate/?hosted_button_id=UXTWMT8P6HE2C)
+
 ## 🚀 Download & Install
 
 [![Windows](https://img.shields.io/badge/🪟_Windows-0078D4?style=for-the-badge&logo=windows&logoColor=white&labelColor=2d3748)](https://github.com/Arrowar/spotdown/releases/latest/download/spotdown_win.exe)
@@ -50,7 +51,7 @@ Dynamic: summary
 
 ---
 
-*⚡ **Quick Start:** `pip install spotdown` or download the executable for your platform above*
+*⚡ **Quick Start:** `pip install spotdown && spotdown`*
 
 </div>
 
@@ -58,9 +59,9 @@ Dynamic: summary
 
 - [✨ Features](#features)
 - [🛠️ Installation](#️installation)
+- [⚙️ Setup](#setup)
 - [⚙️ Configuration](#configuration)
 - [💻 Usage](#usage)
-- [⚠️ Disclaimer](#disclaimer)
 
 ## Features
 
@@ -68,38 +69,61 @@ Dynamic: summary
 - 📋 **Download entire playlists** with ease
 - 🔍 **No authentication required** - uses web scraping
 - 🎨 **Automatic cover art embedding** (JPEG format)
+- ⚡ **Simple command-line interface** - just run `spotdown`!
 
 ## Installation
 
-### Prerequisites
+### Method 1: PyPI (Recommended)
 
-- **Python 3.8+**
-- **FFmpeg** (for audio processing)
-- **yt-dlp** (for downloading)
+```bash
+pip install spotdown
+```
 
-### 1. Install Python Dependencies
+That's it! You can now run `spotdown` from anywhere in your terminal.
+
+### Method 2: From Source
+
+If you prefer to install from source:
 
 ```bash
-pip install -r requirements.txt
+git clone https://github.com/Arrowar/spotdown.git
+cd spotdown
+pip install -e .
 ```
 
-### 2. Install Playwright Chromium
+### Prerequisites
+
+The following dependencies will be automatically installed:
+
+- **Python 3.8+**
+- **FFmpeg** (for audio processing)
+- **yt-dlp** (for downloading)
+- **Playwright** (for web scraping)
+
+After installation, run this one-time setup command:
 
 ```bash
 playwright install chromium
 ```
 
-### 3. Quick Start
+## Setup
 
-Create a simple launcher script:
+1. Go to the [Spotify Developer Dashboard](https://developer.spotify.com/dashboard/)
+2. Log in and create a new application
+3. Copy your **Client ID** and **Client Secret**
+4. Create a file named `.env` in the SpotDown directory with the following content:
 
-```python
-from spotdown.run import main
-
-if __name__ == "__main__":
-    main()
+```
+SPOTIFY_CLIENT_ID=your_client_id_here
+SPOTIPY_CLIENT_SECRET=your_client_secret_here
 ```
 
+5. Save the file. SpotDown will automatically load these credentials.
+
+### Error Handling
+- If the credentials are missing, SpotDown will log an error and exit.
+- If the credentials are invalid, SpotDown will log an error and exit. Please double-check your `.env` file and credentials.
+
 ## Configuration
 
 SpotDown uses a JSON configuration file with the following structure:
@@ -113,10 +137,6 @@ SpotDown uses a JSON configuration file with the following structure:
     "DOWNLOAD": {
         "auto_first": false,
         "quality": "320K"
-    },
-    "BROWSER": {
-        "headless": true,
-        "timeout": 6
     }
 }
 ```
@@ -131,21 +151,21 @@ SpotDown uses a JSON configuration file with the following structure:
 - **`auto_first`**: Automatically select first search result
 - **`quality`**: Audio quality (320K recommended for best quality)
 
-#### BROWSER Settings
-- **`headless`**: Run browser in background (recommended: true)
-- **`timeout`**: Browser timeout in seconds
-
 ## Usage
 
-### Basic Usage
+### Starting SpotDown
+
+Simply run the following command in your terminal:
 
 ```bash
-python run.py
+spotdown
 ```
 
+The interactive interface will guide you through the download process.
+
 ### Download Individual Songs
 
-1. Run the script
+1. Run `spotdown`
 2. Paste the Spotify song URL when prompted
 3. The script will automatically:
    - Extract song information
@@ -154,15 +174,28 @@ python run.py
 
 ### Download Playlists
 
-1. Run the script  
+1. Run `spotdown`
 2. Paste the Spotify playlist URL when prompted
 3. All songs in the playlist will be downloaded automatically
 
+### Example Usage
+
+```bash
+$ spotdown
+🎵 Welcome to SpotDown!
+Please paste your Spotify URL: https://open.spotify.com/track/4iV5W9uYEdYUVa79Axb7Rh
+🔍 Processing: Song Name - Artist Name
+⬇️ Downloading...
+✅ Download complete!
+```
+
 ## To Do
 
 - [ ] Implement batch download queue
 - [ ] Add GUI interface option
 - [ ] Support for additional music platforms
+- [ ] Album art quality selection
+- [ ] Custom output directory configuration
 
 ## Disclaimer
 

{spotdown-0.1.1 → spotdown-1.3.0}/README.md

@@ -9,6 +9,7 @@
 ## 💝 Support the Project
 
 [![Donate PayPal](https://img.shields.io/badge/💳_Donate-PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white&labelColor=2d3748)](https://www.paypal.com/donate/?hosted_button_id=UXTWMT8P6HE2C)
+
 ## 🚀 Download & Install
 
 [![Windows](https://img.shields.io/badge/🪟_Windows-0078D4?style=for-the-badge&logo=windows&logoColor=white&labelColor=2d3748)](https://github.com/Arrowar/spotdown/releases/latest/download/spotdown_win.exe)
@@ -18,7 +19,7 @@
 
 ---
 
-*⚡ **Quick Start:** `pip install spotdown` or download the executable for your platform above*
+*⚡ **Quick Start:** `pip install spotdown && spotdown`*
 
 </div>
 
@@ -26,9 +27,9 @@
 
 - [✨ Features](#features)
 - [🛠️ Installation](#️installation)
+- [⚙️ Setup](#setup)
 - [⚙️ Configuration](#configuration)
 - [💻 Usage](#usage)
-- [⚠️ Disclaimer](#disclaimer)
 
 ## Features
 
@@ -36,38 +37,61 @@
 - 📋 **Download entire playlists** with ease
 - 🔍 **No authentication required** - uses web scraping
 - 🎨 **Automatic cover art embedding** (JPEG format)
+- ⚡ **Simple command-line interface** - just run `spotdown`!
 
 ## Installation
 
-### Prerequisites
+### Method 1: PyPI (Recommended)
 
-- **Python 3.8+**
-- **FFmpeg** (for audio processing)
-- **yt-dlp** (for downloading)
+```bash
+pip install spotdown
+```
 
-### 1. Install Python Dependencies
+That's it! You can now run `spotdown` from anywhere in your terminal.
+
+### Method 2: From Source
+
+If you prefer to install from source:
 
 ```bash
-pip install -r requirements.txt
+git clone https://github.com/Arrowar/spotdown.git
+cd spotdown
+pip install -e .
 ```
 
-### 2. Install Playwright Chromium
+### Prerequisites
+
+The following dependencies will be automatically installed:
+
+- **Python 3.8+**
+- **FFmpeg** (for audio processing)
+- **yt-dlp** (for downloading)
+- **Playwright** (for web scraping)
+
+After installation, run this one-time setup command:
 
 ```bash
 playwright install chromium
 ```
 
-### 3. Quick Start
+## Setup
 
-Create a simple launcher script:
+1. Go to the [Spotify Developer Dashboard](https://developer.spotify.com/dashboard/)
+2. Log in and create a new application
+3. Copy your **Client ID** and **Client Secret**
+4. Create a file named `.env` in the SpotDown directory with the following content:
 
-```python
-from spotdown.run import main
-
-if __name__ == "__main__":
-    main()
+```
+SPOTIFY_CLIENT_ID=your_client_id_here
+SPOTIPY_CLIENT_SECRET=your_client_secret_here
 ```
 
+5. Save the file. SpotDown will automatically load these credentials.
+
+### Error Handling
+- If the credentials are missing, SpotDown will log an error and exit.
+- If the credentials are invalid, SpotDown will log an error and exit. Please double-check your `.env` file and credentials.
+
 ## Configuration
 
 SpotDown uses a JSON configuration file with the following structure:
@@ -81,10 +105,6 @@ SpotDown uses a JSON configuration file with the following structure:
     "DOWNLOAD": {
         "auto_first": false,
         "quality": "320K"
-    },
-    "BROWSER": {
-        "headless": true,
-        "timeout": 6
     }
 }
 ```
@@ -99,21 +119,21 @@ SpotDown uses a JSON configuration file with the following structure:
 - **`auto_first`**: Automatically select first search result
 - **`quality`**: Audio quality (320K recommended for best quality)
 
-#### BROWSER Settings
-- **`headless`**: Run browser in background (recommended: true)
-- **`timeout`**: Browser timeout in seconds
-
 ## Usage
 
-### Basic Usage
+### Starting SpotDown
+
+Simply run the following command in your terminal:
 
 ```bash
-python run.py
+spotdown
 ```
 
+The interactive interface will guide you through the download process.
+
 ### Download Individual Songs
 
-1. Run the script
+1. Run `spotdown`
 2. Paste the Spotify song URL when prompted
 3. The script will automatically:
    - Extract song information
@@ -122,15 +142,28 @@ python run.py
 
 ### Download Playlists
 
-1. Run the script  
+1. Run `spotdown`
 2. Paste the Spotify playlist URL when prompted
 3. All songs in the playlist will be downloaded automatically
 
+### Example Usage
+
+```bash
+$ spotdown
+🎵 Welcome to SpotDown!
+Please paste your Spotify URL: https://open.spotify.com/track/4iV5W9uYEdYUVa79Axb7Rh
+🔍 Processing: Song Name - Artist Name
+⬇️ Downloading...
+✅ Download complete!
+```
+
 ## To Do
 
 - [ ] Implement batch download queue
 - [ ] Add GUI interface option
 - [ ] Support for additional music platforms
+- [ ] Album art quality selection
+- [ ] Custom output directory configuration
 
 ## Disclaimer
 

{spotdown-0.1.1 → spotdown-1.3.0}/SpotDown/downloader/youtube_downloader.py

@@ -1,6 +1,7 @@
 # 05.04.2024
 
 import io
+import logging
 import subprocess
 from typing import Dict
 
@@ -14,7 +15,7 @@ from rich.console import Console
 
 # Internal utils
 from SpotDown.utils.config_json import config_manager
-from SpotDown.utils.file_utils import FileUtils
+from SpotDown.utils.file_utils import file_utils
 
 
 # Variable
@@ -24,7 +25,7 @@ quality = config_manager.get("DOWNLOAD", "quality")
 class YouTubeDownloader:
     def __init__(self):
         self.console = Console()
-        self.file_utils = FileUtils()
+        self.file_utils = file_utils
 
     def download(self, video_info: Dict, spotify_info: Dict) -> bool:
         """
@@ -44,6 +45,7 @@ class YouTubeDownloader:
                 spotify_info.get('title', video_info.get('title', 'Unknown Title'))
             )
             output_path = music_folder / f"{filename}.%(ext)s"
+            logging.info(f"Start download: {video_info.get('url')} as {output_path}")
 
             # Download cover image if available
             cover_path = None
@@ -65,12 +67,15 @@ class YouTubeDownloader:
                                 img.save(cover_path, "JPEG")
 
                             self.console.print(f"[blue]Downloaded thumbnail: {cover_path}[/blue]")
+                            logging.info(f"Downloaded thumbnail: {cover_path}")
 
                         else:
                             cover_path = None
+                            logging.warning(f"Failed to download cover image, status code: {resp.status_code}")
                             
                 except Exception as e:
                     self.console.print(f"[yellow]Unable to download cover: {e}[/yellow]")
+                    logging.error(f"Unable to download cover: {e}")
                     cover_path = None
 
             ytdlp_options = [
@@ -82,6 +87,7 @@ class YouTubeDownloader:
                 '--no-playlist',
                 '--embed-metadata',
                 '--add-metadata',
+                '--ffmpeg-location', self.file_utils.ffmpeg_path
             ]
             
             if cover_path and cover_path.exists():
@@ -94,6 +100,7 @@ class YouTubeDownloader:
                 console=self.console
             ) as progress:
                 task = progress.add_task("Downloading...", total=None)
+                logging.info(f"Running yt-dlp with options: {ytdlp_options}")
                 process = subprocess.run(
                     ytdlp_options,
                     capture_output=True,
@@ -102,30 +109,37 @@ class YouTubeDownloader:
                 progress.remove_task(task)
 
             if process.returncode == 0:
+                logging.info("yt-dlp finished successfully")
 
                 # Find the downloaded file
                 downloaded_files = list(music_folder.glob(f"{filename}.*"))
                 if downloaded_files:
                     self.console.print("[red]Download completed![/red]")
+                    logging.info(f"Download completed: {downloaded_files[0]}")
 
                     # Remove cover file after embedding
                     if cover_path and cover_path.exists():
                         try:
                             cover_path.unlink()
-                        except Exception:
-                            pass
-                        
+                            logging.info(f"Removed temporary cover file: {cover_path}")
+
+                        except Exception as ex:
+                            logging.warning(f"Failed to remove cover file: {ex}")
+
                     return True
                 
                 else:
                     self.console.print("[yellow]Download apparently succeeded but file not found[/yellow]")
+                    logging.error("Download apparently succeeded but file not found")
                     return False
-                
+            
             else:
                 self.console.print("[red]Download error:[/red]")
                 self.console.print(f"[red]{process.stderr}[/red]")
+                logging.error(f"yt-dlp error: {process.stderr}")
                 return False
 
         except Exception as e:
             self.console.print(f"[red]Error during download: {e}[/red]")
+            logging.error(f"Error during download: {e}")
             return False

spotdown-1.3.0/SpotDown/extractor/spotify_extractor.py

@@ -0,0 +1,218 @@
+# 05.04.2024
+
+import os
+import re
+import sys
+import json
+import logging
+from typing import Dict, List, Optional
+from dotenv import load_dotenv
+
+
+# External library
+import spotipy
+from spotipy.oauth2 import SpotifyClientCredentials
+from rich.console import Console
+from rich.progress import Progress
+
+
+# Variable
+console = Console()
+load_dotenv()
+
+
+def extract_track_id(spotify_url):
+    patterns = [
+        r'track/([a-zA-Z0-9]{22})',
+        r'spotify:track:([a-zA-Z0-9]{22})'
+    ]
+    for pattern in patterns:
+        match = re.search(pattern, spotify_url)
+        if match:
+            return match.group(1)
+    return None
+
+
+def extract_playlist_id(spotify_url):
+    patterns = [
+        r'playlist/([a-zA-Z0-9]{22})',
+        r'spotify:playlist:([a-zA-Z0-9]{22})'
+    ]
+    for pattern in patterns:
+        match = re.search(pattern, spotify_url)
+        if match:
+            return match.group(1)
+    return None
+
+
+class SpotifyExtractor:
+    def __init__(self):
+        client_id = os.getenv("SPOTIPY_CLIENT_ID")
+        client_secret = os.getenv("SPOTIPY_CLIENT_SECRET")
+
+        if not client_id or not client_secret:
+            console.print("[red]Missing Spotify credentials. Please create a .env file with SPOTIFY_CLIENT_ID and SPOTIPY_CLIENT_SECRET from https://developer.spotify.com/dashboard/")
+            sys.exit(1)
+
+        self.sp = spotipy.Spotify(auth_manager=SpotifyClientCredentials(
+            client_id=client_id,
+            client_secret=client_secret
+        ))
+        logging.info("SpotifyExtractor initialized")
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        pass
+
+    def extract_track_info(self, spotify_url: str, save_json: bool = False) -> Optional[Dict]:
+        track_id = extract_track_id(spotify_url)
+        if not track_id:
+            logging.error("Invalid Spotify track URL")
+            return None
+        
+        try:
+            # Extract track info
+            track = self.sp.track(track_id)
+
+            # Extract album info
+            album = track['album']
+
+            # Process extracted data
+            release_date = album['release_date']
+            year = release_date.split('-')[0] if release_date else None
+
+            # Extract duration in seconds and formatted
+            duration_ms = track['duration_ms']
+            duration_seconds = duration_ms // 1000 if duration_ms else None
+            duration_formatted = f"{duration_seconds // 60}:{duration_seconds % 60:02d}" if duration_seconds else None
+
+            # Extract cover URL
+            cover_url = album['images'][0]['url'] if album['images'] else None
+
+            # Extract artists
+            artists = [artist['name'] for artist in track['artists']]
+
+            # Compile track info
+            track_info = {
+                'artist': ', '.join(artists),
+                'title': track['name'],
+                'album': album['name'],
+                'year': year,
+                'duration_seconds': duration_seconds,
+                'duration_formatted': duration_formatted,
+                'cover_url': cover_url
+            }
+
+            if save_json:
+                log_dir = os.path.join(os.getcwd(), "log")
+                os.makedirs(log_dir, exist_ok=True)
+
+                # Create JSON file for track info
+                filename = f"{track_info['artist']} - {track_info['title']}.json"
+                filepath = os.path.join(log_dir, filename)
+
+                # Save track info to JSON
+                with open(filepath, "w", encoding="utf-8") as f:
+                    json.dump(track_info, f, ensure_ascii=False, indent=2)
+
+            return track_info
+        except Exception as e:
+            error_msg = str(e)
+            logging.error(f"Spotify extraction error: {error_msg}")
+
+            if "invalid_client" in error_msg:
+                console.print("[red]Spotify credentials are invalid. Please check your .env file and obtain valid credentials from https://developer.spotify.com/dashboard/. Exiting.")
+                sys.exit(0)
+                
+            return None
+
+    def extract_playlist_tracks(self, playlist_url: str) -> List[Dict]:
+        playlist_id = extract_playlist_id(playlist_url)
+
+        if not playlist_id:
+            logging.error("Invalid Spotify playlist URL")
+            return []
+        
+        try:
+
+            # Extract playlist info
+            playlist = self.sp.playlist(playlist_id)
+            total_tracks = playlist['tracks']['total']
+            tracks_info = []
+            offset = 0
+            limit = 100
+            console.print(f"[green]Playlist has [red]{total_tracks}[/red] tracks.")
+
+            with Progress() as progress:
+                task = progress.add_task("[cyan]Extracting tracks...", total=total_tracks)
+
+                while offset < total_tracks:
+                    progress.update(task, advance=0, description=f"[cyan]Loading tracks {offset + 1}-{min(offset + limit, total_tracks)} of {total_tracks}...")
+                    results = self.sp.playlist_items(
+                        playlist_id,
+                        offset=offset,
+                        limit=limit,
+                        fields='items(track(name,artists(name),album(name,release_date,images),duration_ms))'
+                    )
+
+                    if not results['items']:
+                        break
+
+                    for idx, item in enumerate(results['items']):
+                        if item['track'] is None:
+                            continue
+                        
+                        # Extract track details
+                        track = item['track']
+
+                        # Extract album info
+                        album = track['album']
+
+                        # Process extracted data
+                        #release_date = album['release_date']
+                        #year = release_date.split('-')[0] if release_date else None
+
+                        # Extract duration in seconds
+                        duration_ms = track['duration_ms']
+                        duration_seconds = duration_ms // 1000 if duration_ms else None
+
+                        # Extract cover URL
+                        cover_url = album['images'][0]['url'] if album['images'] else None
+
+                        # Extract artists
+                        artists = [artist['name'] for artist in track['artists']]
+
+                        # Compile track info
+                        track_info = {
+                            "title": track['name'],
+                            "artist": ', '.join(artists),
+                            "album": album['name'],
+                            "added_at": None,
+                            "cover_art": cover_url,
+                            "duration_ms": duration_ms,
+                            "duration_seconds": duration_seconds,
+                            "play_count": None
+                        }
+
+                        # Append to list
+                        tracks_info.append(track_info)
+                        progress.update(task, advance=1)
+                    offset += limit
+
+            # Remove duplicates based on title and artist
+            unique = {}
+            for item in tracks_info:
+                key = (item.get("title", ""), item.get("artist", ""))
+                if key not in unique:
+                    unique[key] = item
+
+            # Convert back to list
+            unique_tracks = list(unique.values())
+            console.print(f"[green]Extracted [red]{len(unique_tracks)}[/red] unique tracks from playlist")
+            return unique_tracks
+        
+        except Exception as e:
+            logging.error(f"Error extracting playlist: {e}")
+            return []