fix logging and action

Author: cainky

.github/workflows/download.yml

@@ -6,17 +6,16 @@ on:
       playlist_url:
         description: 'SoundCloud Playlist URL'
         required: true
-      zip_files:
-        description: 'Zip the downloaded files?'
-        required: true
-        default: 'true'
       output_folder:
         description: 'Output folder name'
         required: false
         default: 'output'
 
 jobs:
   run:
+    permissions:
+      contents: read
+      actions: write
     runs-on: ubuntu-latest
 
     steps:
@@ -43,8 +42,7 @@ jobs:
         run: |
           poetry run python -m soundclouddownloader.cli_entry \
             --url "${{ github.event.inputs.playlist_url }}" \
-            --output "${{ github.event.inputs.output_folder }}" \
-            $([[ "${{ github.event.inputs.zip_files }}" == "true" ]] && echo "--zip")
+            --output "${{ github.event.inputs.output_folder }}"
 
       - name: Upload output files
         uses: actions/upload-artifact@v4

.github/workflows/python-tests.yml

@@ -8,6 +8,8 @@ on:
 
 jobs:
   test:
+    permissions:
+      contents: read
     runs-on: ubuntu-latest
 
     steps:
@@ -29,4 +31,4 @@ jobs:
     
     - name: Run tests
       run: |
-        poetry run python -m unittest discover
+        poetry run python -m unittest discover

README.md

@@ -2,6 +2,8 @@
 
 ## Description
 
+The easiest way to run this is to fork and run via github actions.
+
 This project provides a Python script for downloading entire playlists from SoundCloud. It uses [yt-dlp](https://github.com/yt-dlp/yt-dlp) to handle the downloading process, making it robust against changes in SoundCloud's website structure. The script downloads each track in the playlist, converts them to MP3 format, and optionally packages them into a zip file.
 
 This project uses Poetry for dependency management and packaging. If you haven't installed Poetry yet, you can do so by following the [official installation guide](https://python-poetry.org/docs/#installation).
@@ -13,12 +15,19 @@ This project uses Poetry for dependency management and packaging. If you haven't
 - FFmpeg
 - Poetry
 
-## Installation
+
+## Running the program
+You have 2 options:
+### 1. Github Actions
+
+- The simplest and fastest way to get your own hosted version
+- Simply fork this repo and run via Github action
+
+### 2. Local Installation
 
 1. Clone this repository:
 ```python
 git clone https://github.com/cainky/soundclouddownloader.git
-cd soundclouddownloader
 ```
 
 2. Install the required Python packages:
@@ -36,10 +45,11 @@ poetry install
 1. Run the script:
 
 ```python
+cd soundclouddownloader
 poetry run python main.py
 ```
 
-2. When prompted, enter the URL of the SoundCloud playlist you want to download. Paste the entire url including the `?si=` part. Playlist can be private.
+2. When prompted, enter the URL of the SoundCloud playlist you want to download. Paste the entire url including the `?si=` part. Playlist can be private, just use the Share button to get the private link.
 
 3. Enter Y/n if you want the script to create a zip file of all the tracks.
 

poetry.lock

@@ -18,10 +18,9 @@ def run(playlist_url: str, output_dir: Path, should_zip: bool = False):
     parser = argparse.ArgumentParser(description="CLI for SoundCloud Downloader")
     parser.add_argument("--url", required=True, help="SoundCloud playlist URL")
     parser.add_argument("--output", default="output", help="Output directory")
-    parser.add_argument("--zip", action="store_true", help="Zip downloaded files")
     args = parser.parse_args()
 
     output_path = Path(args.output).resolve()
     output_path.mkdir(parents=True, exist_ok=True)
 
-    run(args.url, output_path, args.zip)
+    run(args.url, output_path, False)

soundclouddownloader/cli_entry.py

@@ -69,24 +69,26 @@ def download_track(self, track: Track, output_dir: Path) -> Optional[Path]:
             else:
                 filepath = None
 
-            if filepath:
-                logger.info(f"Successfully downloaded: {filepath}")
-                return filepath
-            else:
-                logger.info(f"File not found after download: {filepath_without_ext}")
+            if not filepath:
                 dir_contents = list(Path(output_dir).iterdir())
-                logger.debug(f"Directory contents: {[str(f) for f in dir_contents]}")
 
                 # Try to find a file with a similar name
                 similar_files = [
                     f for f in dir_contents if f.stem.startswith(clean_name)
                 ]
                 if similar_files:
-                    similar_file = similar_files[0]
-                    logger.info(f"Found similar file: {similar_file}")
-                    return similar_file
-
-                return None
+                    filepath = similar_files[0]
+                if not filepath:
+                    logger.info(
+                        f"File not found after download: {filepath_without_ext}"
+                    )
+                    logger.debug(
+                        f"Directory contents: {[str(f) for f in dir_contents]}"
+                    )
+                    return None
+
+            logger.info(f"Successfully downloaded: {filepath}")
+            return filepath
 
     def get_playlist_info(self, playlist_url: str) -> Playlist:
         """
@@ -207,14 +209,11 @@ def main() -> None:
 
     downloader = SoundCloudDownloader()
     logger.info("Downloading now please wait...")
-    zip_file = downloader.download_playlist(
+    download = downloader.download_playlist(
         playlist_url, output_dir, max_workers=3, should_zip=should_zip
     )
-    if zip_file:
-        if should_zip:
-            logger.success(f"Playlist downloaded and zipped: {zip_file}")
-        else:
-            logger.success(f"Playlist downloaded to directory: {zip_file}")
+    if download:
+        logger.success(f"Playlist downloaded: {download}")
     else:
         logger.error("Failed to download playlist.")
     sys.stdout.flush()