Skip to main content

Terminal based YouTube player and downloader

Project description

https://img.shields.io/pypi/v/mps-youtube.svg https://img.shields.io/pypi/dm/mps-youtube.svg Wheel Status

Features

  • Search and play audio/video from YouTube

  • Search tracks of albums by album title

  • Search and import YouTube playlists

  • Create and save local playlists

  • Download audio/video

  • Convert to mp3 & other formats (requires ffmpeg or avconv)

  • View video comments

  • Works with Python 3.x

  • Works with Windows, Linux and Mac OS X

  • Requires mplayer or mpv

This project is based on mps, a terminal based program to search, stream and download music. This implementation uses YouTube as a source of content and can play and download video as well as audio. The pafy library handles interfacing with YouTube.

FAQ / Troubleshooting common issues

Screenshots

Local Playlists

http://np1.github.io/mpsyt-images2/local-playlists.png

Search result items can easily be stored in local playlists.

YouTube Playlists

http://np1.github.io/mpsyt-images2/playlist-search.png

YouTube playlists can be searched and played or saved as local playlists.

Download

http://np1.github.io/mpsyt-images2/download.png

Content can be downloaded in various formats and resolutions.

Comments

http://np1.github.io/mpsyt-images2/comments.png

A basic comments browser is available to view YouTube user comments.

Music Album Matching

http://np1.github.io/mpsyt-images2/album-1.png http://np1.github.io/mpsyt-images2/album-2.png

An album title can be specified and mps-youtube will attempt to find matches for each track of the album, based on title and duration. Type help search for more info.

Customisation

http://np1.github.io/mpsyt-images2/customisation2.png

Search results can be customised to display additional fields and ordered by various criteria.

This configuration was set up using the following commands:

set order views
set columns user:14 date comments rating likes dislikes category:9 views

Type help config for help on configuration options

Installation

Using pip:

[sudo] pip3 install mps-youtube

Installing youtube_dl is highly recommended:

[sudo] pip3 install youtube_dl

Additional Mac OS X installation notes

Install mplayer with MacPorts:

sudo port install MPlayer

Or with Homebrew:

brew install mplayer

Additional Windows installation notes

As an alternative to installing with pip, there is a standalone binary available. Go to Releases and download mpsyt-VERSION.exe under downloads for the latest release.

Install the python colorama module to get colors (optional):

pip3 install colorama

Download mplayer for your CPU type from the “Build Selection table” here.

Extract the mplayer.exe file, saving it to the folder that mpsyt.exe resides in (usually C:\PythonXX\Scripts\) or to a folder in the system path.

Alternatively to mplayer, use mpv.exe which can be downloaded from: http://mpv.io/installation/

Run via Docker container

Using Docker, run with:

sudo docker run -v /dev/snd:/dev/snd -it --rm --privileged --name mpsyt mpsyt

Additional Docker notes

If you would like to locally build the container you can run the following steps

Check out this repo:

git clone https://github.com/np1/mps-youtube.git

Enter the directory and run docker build:

cd mps-youtube
sudo docker build -t mpsyt .

Now run the container interactively with:

sudo docker run -v /dev/snd:/dev/snd -it --rm --privileged --name mpsyt mpsyt

In order to have access to the local sound device (/dev/snd) the container needs to be privileged.

Upgrading

Upgrade pip installation:

[sudo] pip3 install mps-youtube --upgrade

Usage

mps-youtube is run on the command line using the command:

mpsyt

Enter h from within the program for help.

IRC

An IRC channel #mps-youtube for the project is available on Freenode (chat.freenode.net:6697).

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mps-youtube-0.2.7.1.tar.gz (78.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mps_youtube-0.2.7.1-py3-none-any.whl (74.3 kB view details)

Uploaded Python 3

File details

Details for the file mps-youtube-0.2.7.1.tar.gz.

File metadata

  • Download URL: mps-youtube-0.2.7.1.tar.gz
  • Upload date:
  • Size: 78.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for mps-youtube-0.2.7.1.tar.gz
Algorithm Hash digest
SHA256 e3df5dc80f39941cb38f5678d1cc397a37a6dc5577e487b24fbf66fffe2afd03
MD5 6b834b25fab8f87378976f1a798044e0
BLAKE2b-256 6124731d187970c531023655df748a63b09dc44a6102ce5997ef52e6285acb1d

See more details on using hashes here.

File details

Details for the file mps_youtube-0.2.7.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mps_youtube-0.2.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a6efb261b8d103a206db49dac608bceb2a96e2a9c5ba69e139b0ce5316e05c4f
MD5 7ac810e47b6d6402dea8aefb36d56ce8
BLAKE2b-256 8659f81a2873f096a9780d59e3f1bebba03906f08fd0a7fb270dc1d4822c462f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page