dmp3 0.0.8

Installation

1. Install Python >= 3.13.

2. Install package from pypi.

   pip install -U dmp3

3. Install FFMPEG, it converts media formats.

   Linux

   sudo apt install ffmpeg

   Windows

   1. Install from ffmpeg download page, most likely use windows installer.

   2. Add the bin folder that contains ffmpeg.exe to system path, so that it is available on command line.

Simple Usage

Linux:

cd /home/user/Projects/utube_playlist_mp3_downloader/tests/mp3_dir
dmp3 starcraft_terran -w https://www.youtube.com/playlist?list=PLEtYTVnkBVuZWJ4Gsxtt80tWbiiyy1bcy

Windows:

dmp3 "D:\media\music\game_theme\starcraft_terran" -w https://www.youtube.com/playlist?list=PLEtYTVnkBVuZWJ4Gsxtt80tWbiiyy1bcy

Download as video instead of mp3:

dmp3 starcraft_terran -w https://www.youtube.com/playlist?list=PLEtYTVnkBVuZWJ4Gsxtt80tWbiiyy1bcy -v

Example results:

mp3_dir/
├── diablo1
│   ├── .dmp3
│   ├── Diablo 1 [OST] - 01 - Intro-Y7P7vrvEQYc.mp3
│   ├── Diablo 1 [OST] - 02 - Town-SEpydfXj87M.mp3
│   ├── Diablo 1 [OST] - 03 - Dungeon-yQCg-uHOrZk.mp3
│   ├── Diablo 1 [OST] - 04 - Catacombs-FPQPJwVX-60.mp3
│   ├── Diablo 1 [OST] - 05 - Caves-J9OIyH21ZKo.mp3
│   └── Diablo 1 [OST] - 06 - Hell-5PBG92gkL7I.mp3
└── starcraft_terran
    ├── .dmp3
    ├── StarCraft - Terran Theme 1-mD4GbGmvNRc.mp3
    ├── Starcraft 2 Soundtrack - Terran 01-zAS8KivZX5s.mp3
    ├── Starcraft 2 Soundtrack - Terran 02-sNbTg0Li36k.mp3
    ├── Starcraft 2 Soundtrack - Terran 03-dssNa11htIM.mp3
    ├── Starcraft 2 Soundtrack - Terran 04-4YfQjho2IOk.mp3
    ├── Starcraft 2 Soundtrack - Terran 05-fQluJBSXM5I.mp3
    ├── Terran Theme 2 - Starcraft Soundtrack-_R1QLIo16DY.mp3
    ├── Terran Theme 3 - Starcraft Soundtrack-xcEHDqji74A.mp3
    └── Terran Theme 4 (Brood War) - Starcraft Soundtrack-l9XSZw67QpY.mp3

Refresh multiple local storage folders, each tracking a playlist or a channel:

cd /home/user/Projects/utube_playlist_mp3_downloader/tests/mp3_dir
dmp3 . -r

Usage in python script:

from dmp3 import dmp3
from pathlib import Path

folder = Path("/home/user/Projects/utube_playlist_mp3_downloader/tests/mp3_dir/starcraft_terran")
webpath = "https://www.youtube.com/playlist?list=PLEtYTVnkBVuZWJ4Gsxtt80tWbiiyy1bcy"

dmp3(folder=folder)
dmp3(folder=folder, webpath=webpath, start=1, end=3, refresh_folder_mode=False, mp3=True)
dmp3(folder=folder, webpath=webpath, mp3=False)  # Download as video

API

usage: dmp3 [-h] [-w WEBPATH] [-s START] [-e END] [-r] [-v] folder

Download youtube video, playlist, channel. Convert to mp3, store into folder. Efficiently refresh mutiple storage folders.

Creates folder if not exists.
Otherwise only download additional mp3 into the folder.

If webpath is provided, creates a .dmp3 file in the folder to store parameters.
If not provided, uses saved parameter.

If start and/or end are provided, download only the subset in addition to already downloaded.
If not provided, uses saved parameters if any.

positional arguments:
folder                Folder to store mp3 files

options:
-h, --help            show this help message and exit
-w WEBPATH, --webpath WEBPATH
                        Webpath to download from, creates a .dmp3 file insdie folder to store parameters
-s START, --start START
                        Start index of the playlist
-e END, --end END     End index of the playlist
-r, --refresh_folder_mode
                        Refresh all mp3 folders in the folder, default is False
-v, --video           Download video without converting to mp3 (by default converts to mp3)

Examples:

A video as mp3:
dmp3 . -w "https://www.youtube.com/watch?v=mD4GbGmvNRc"

A video:
dmp3 . -v -w "https://www.youtube.com/watch?v=mD4GbGmvNRc"

Entire playlist:
cd /home/user/Projects/utube_playlist_mp3_downloader/tests/mp3_dir
dmp3 starcraft_terran -w https://www.youtube.com/playlist?list=PLEtYTVnkBVuZWJ4Gsxtt80tWbiiyy1bcy

Part of playlist:
dmp3 starcraft_terran -w https://www.youtube.com/playlist?list=PLEtYTVnkBVuZWJ4Gsxtt80tWbiiyy1bcy -s 1 -e 2

Most recent 5 videos from channel:
dmp3 diablo -w https://www.youtube.com/@Diablo/videos -e 5

Refresh entire or part of playlist:
dmp3 starcraft_terran
dmp3 starcraft_terran -s 5

Refresh channel using saved parameters:
dmp3 diablo

Refresh all storage folders, each with saved parameters:
cd /home/user/Projects/utube_playlist_mp3_downloader/tests/mp3_dir
dmp3 . -r