Build Status PyPi Version CodeCov Documentation Status PyPI Python Versions License

preview

Description

This program simplifies the process of searching, downloading and converting Youtube videos to MP3 files from the command-line. All you need is the video URL or the name of the artist/track you’re looking for.
The program will attempt to retrieve data for a song matching the provided input by querying the iTunes API and use the data to find a corresponding YouTube video, if a URL is not provided. The video will then be downloaded, converted, and the gathered data will be used to populate the metadata of the MP3.
Once finished, the resulting MP3 file will be saved to your Downloads directory, with the following file-structure Music/{artist}/{track}.mp3.

Note: If a URL is provided and no match is found for the song data, the program will prompt the user for the track/artist and the YouTube thumbnail will be used as the album artwork.

Getting Started

Prerequisites

The program only requires that you have Python 3.4+ and ffmpeg or libav installed. For more information, check out the additional setup.

Install

You can install the program with the following command:

1$ pip install yt2mp3

Usage

The program can be executed via the as follows:

1$ yt2mp3 [-options]

Options:


Flag
-t, --trackSpecify the track name query
-a, --artistSpecify the artist name query
-u, --urlSpecify a Youtube URL or ID
-p, --playlistSpecify a Youtube playlist URL or ID
-o, --overwriteOverwrite the file if one exists in output directory
-r, --resolutionSpecify the resolution for the cover-art
-q, --quietSuppress program command-line output
-v, --verboseDisplay a command-line progress bar
--versionShow the version number and exit
-h, --helpDisplay information on usage and functionality

Note: Displaying the progress bar with the -v, --verbose flag currently has a significant impact on download performance, due to #180.


Documentation

Further documentation is available on Read The Docs

Development

If you’d like to contribute to the project, you can download and install the program with the following commands:

1# Clone the repository / most up to date is on saftyBranch
2$ git clone https://github.com/tterb/yt2mp3
3
4# Navigate to the directory
5$ cd yt2mp3
6
7# Install program dependencies
8$ pip install -r requirements.txt