[
{
"path": ".gitignore",
"content": "*.py[cod]\notherstuff/\npafy\nvi.py\nMANIFEST\n.dev\n.vscode\n# Packages\n*.egg\n*.egg-info\ndist\nbuild\neggs\nparts\nbin\nvar\ntags\n.env\nenv/\n.idea/\nvenv/\ntest.py"
},
{
"path": "CHANGELOG.md",
"content": "# Changelog\n\n\n\n## v2.9.2 (2023-01-26)\n### Fix\n* Remove pyreadline dependency (#105) ([#107](https://github.com/iamtalhaasghar/yewtube/issues/107)) ([`19e4148`](https://github.com/iamtalhaasghar/yewtube/commit/19e4148242380b543a4825962716550114984f11))\n\n## v2.9.1 (2023-01-26)\n### Fix\n* #50 - brought back download audio file ([`b46dab4`](https://github.com/iamtalhaasghar/yewtube/commit/b46dab47e61c68efa0e51836a8cc9141d15d9e87))\n\n## v2.9.0 (2022-10-20)\n### Feature\n* **mplayer:** Set cache ([#93](https://github.com/iamtalhaasghar/yewtube/issues/93)) ([`16d3a18`](https://github.com/iamtalhaasghar/yewtube/commit/16d3a186fb9feb24530e1f07b211062c44a515a0))\n\n### Fix\n* #76 video pops up ([`eaeff58`](https://github.com/iamtalhaasghar/yewtube/commit/eaeff58f94e2fd89706e42fdab6b8e82ef770941))\n\n## v2.8.5 (2022-09-08)\n### Fix\n* #75 program crashes while creating custom playlist and saving it without playing ([`2552eff`](https://github.com/iamtalhaasghar/yewtube/commit/2552eff602683fbd28bc6841768bf6cf585fc960))\n* **main:** Handle error when setting locale ([#86](https://github.com/iamtalhaasghar/yewtube/issues/86)) ([`ecd117c`](https://github.com/iamtalhaasghar/yewtube/commit/ecd117ca1ef753509b78082d6f919c9bc2b1756b))\n* Enable quit-watch-later in mpv #77 ([`079e440`](https://github.com/iamtalhaasghar/yewtube/commit/079e44088260c938dc3ae71cd55146fb51de653e))\n\n### Documentation\n* Added common issues file. ([#91](https://github.com/iamtalhaasghar/yewtube/issues/91)) ([`4b69e5e`](https://github.com/iamtalhaasghar/yewtube/commit/4b69e5ee96ed36efa9a68f6315322ed3d44d1e3d))\n\n## v2.8.4 (2022-05-05)\n### Fix\n* #53 viewing playlists uploaded by a user is back ([`f201cb5`](https://github.com/iamtalhaasghar/yewtube/commit/f201cb5f4cd45b9341ced6b549fc35a57e85eb9f))\n\n## v2.8.3 (2022-04-25)\n### Fix\n* #45 fetch all videos of a playlist ([`261f468`](https://github.com/iamtalhaasghar/yewtube/commit/261f4687668c6c05415102c66587a27518bbac10))\n* Save full playlists by name and all its videos ([`d69a959`](https://github.com/iamtalhaasghar/yewtube/commit/d69a9594c5824d97201774e81444b75aea93e861))\n* #67 vlc dummy Interface does not work with live channels ([`2d4637b`](https://github.com/iamtalhaasghar/yewtube/commit/2d4637b04b6f738ab832b3beacab1e490e99a518))\n\n## v2.8.2 (2022-03-17)\n### Fix\n* #63 module album search crash ([`3f2fcfb`](https://github.com/iamtalhaasghar/yewtube/commit/3f2fcfb27bb60928282d1a4a68adff22980f5938))\n\n## v2.8.1 (2022-03-08)\n### Fix\n* #54 play video using youtube short link ([`92d1c77`](https://github.com/iamtalhaasghar/yewtube/commit/92d1c776d4bcc47509becadc5ba9248477dc0dcc))\n* Use mkdocs instead of sphinx docs ([`32a2e9c`](https://github.com/iamtalhaasghar/yewtube/commit/32a2e9cdddac3ebb458d7bdcd793ed83ccc2fdf0))\n\n## v2.8.0 (2022-02-28)\n### Feature\n* **helptext:** Help changelog ([`0643941`](https://github.com/iamtalhaasghar/yewtube/commit/06439411d7a78fe6701f7313e9b3b0720248a197))\n* **setup:** Extras dependencies for mpris ([`936e890`](https://github.com/iamtalhaasghar/yewtube/commit/936e8909b5212eda3a64e8b93be79d4353e6d646))\n\n### Fix\n* #37 use `set pages` command to config how many search result pages to show ([`2baec5f`](https://github.com/iamtalhaasghar/yewtube/commit/2baec5fd11c0edf88d3543dd81333c5ecf67c918))\n* #44 dont run init when importing mps_youtube ([`a072c22`](https://github.com/iamtalhaasghar/yewtube/commit/a072c22e2781160bca79d0164e46e49f07ac28e1))\n* **mpris:** Handle no data on time-pos ([`8bb29d3`](https://github.com/iamtalhaasghar/yewtube/commit/8bb29d33825ad826e51d9d8eada32a9b7bd10ffd))\n* #39 key error 'data' ([`834ed5b`](https://github.com/iamtalhaasghar/yewtube/commit/834ed5b0af5f92e1233e8ba327327654f67f61a0))\n* #38 improved help menu responsiveness ([`972b4ef`](https://github.com/iamtalhaasghar/yewtube/commit/972b4efdb5fe8f5d3295b1c3fe607d209e7d39b6))\n* #35 remove api key instructions ([`4f1fee3`](https://github.com/iamtalhaasghar/yewtube/commit/4f1fee3b711b2383b2704fba39bdce772894cc75))\n* #24 colorama support for windows ([`9cf2616`](https://github.com/iamtalhaasghar/yewtube/commit/9cf261615a52f6ac64b6fb28390db2a71a7ab470))\n\n## v2.7.0 (2022-02-19)\n### Feature\n* Use yewtube over tor using torsocks 🔥 ([`1e9c4ce`](https://github.com/iamtalhaasghar/yewtube/commit/1e9c4ce5992528286f552c8b563daef4abf9566a))\n\n## v2.6.9 (2022-02-19)\n### Fix\n* #28 show changelog with `help new` command ([`d52b65d`](https://github.com/iamtalhaasghar/yewtube/commit/d52b65d0c0cd8708020a2d6788102d82d8ebeee5))\n\n## v2.6.8 (2022-02-19)\n### Fix\n* fixed #26 album search working now without youtube api ([`9c3ae03`](https://github.com/iamtalhaasghar/yewtube/commit/9c3ae03b8c0ae006f1b9a917e4330270fec2f929))\n\n## v2.6.7 (2022-02-19)\n### Fix\n* Check for app updates ([`eabfb52`](https://github.com/iamtalhaasghar/yewtube/commit/eabfb5233c7b87c5f300ebc41250a3f52db07411))\n* Don't crash if playlists / history file has invalid youtube id fixed #24 ([`323d5d8`](https://github.com/iamtalhaasghar/yewtube/commit/323d5d822cefc23889665d71cfffe9e40750433b))\n\n## v2.6.6 (2022-02-18)\n### Fix\n* Playlists are working again fixed #18 ([`bfceee4`](https://github.com/iamtalhaasghar/yewtube/commit/bfceee493261d099c85bf2c4c9e79e5710e9799f))\n* Buffersize warning ([`d185c3f`](https://github.com/iamtalhaasghar/yewtube/commit/d185c3fdf8d520bcb4595f5e458d6022a7b6d1aa))\n* **g:** Mpv msglevel ([`062b125`](https://github.com/iamtalhaasghar/yewtube/commit/062b12503a8fa15dc720cf3ac91f001b74a5cf10))\n\n## v2.6.5 (2022-02-17)\n### Fix\n* Default player priority is vlc > mpv > mplayer on first install fixed #16 ([`35409eb`](https://github.com/iamtalhaasghar/yewtube/commit/35409eb31cc67f03c50589e02cdff2ad08fe4911))\n* **mplayer:** _get_mplayer_version ([`ab21c5d`](https://github.com/iamtalhaasghar/yewtube/commit/ab21c5d1bc872ed482bf482ad37949129c1e4f78))\n* Bring back requirements.txt to life ([`ff6e59d`](https://github.com/iamtalhaasghar/yewtube/commit/ff6e59d75834c61d72ec6bbc92f5eb339cc82607))\n* **util.uea_pad:** Handle AttributeError on t.split ([`1643266`](https://github.com/iamtalhaasghar/yewtube/commit/1643266f21ccf7a99481a1615b4a53c4fbabc878))\n\n## v2.6.4 (2022-02-16)\n### Fix\n* Duplicate changelog and readme files ([`0265ef7`](https://github.com/iamtalhaasghar/yewtube/commit/0265ef7507b539791684bdcf40b30ddaafc525e8))\n\n## v2.6.3 (2022-02-16)\n### Fix\n* Welcome from semantic release python ([`c237a68`](https://github.com/iamtalhaasghar/yewtube/commit/c237a6808869062036f5196775352c1504eafe06))\n\n# yewtube was forked from mps-youtube\n### Features\n* was made to work without YouTube API v3\n* play music in vlc with no gui\n \n \n\n \n \nVersion 0.2.8\n17 February 2018\n\nFeatures:\n---------\n\n- Lastfm scrobbling (@rien333) (#758)\n- `splaylist` and `suser` commands for Spotify (@ritiek) (#678)\n- Autoplay support (@nikhilweee) (#594)\n- `genpl` command (@nishanthkarthik) (#642)\n- `video_format` configuration setting (@Vrihub) (#656)\n- `live` command for live streams (@Razesdark) (#635)\n- Add time column (@akaWolf) (#582)\n- Add video ID column (@Razesdark) (#627)\n- Allow filtering search by duration (@jas32096) (#548)\n- Allow filtering search by date (@jas32096) (#553)\n- Add `history recent` to display history without duplicates (@srvanrell) (#510)\n- `--no-textart` to disable ascii art (for screenreaders) (@Gongreg) (#517)\n- `set_title` option to disable setting window title (@ardrabczyk) (#498)\n- Add `s` command for getting stream information (@ritiek) (#675)\n- Add option to disable mpris (@hrnr) (#728)\n- Generate playlist from video description (@Razesdark) (#649)\n\nEnhancements:\n-------------\n- Store playlists as m3u files instead of binary (@kraetzin) (#682)\n- Show replies when displaying comments (@paulfertser) (#677)\n- Use https urls for album art (@vszakats) (#574)\n- When using \"repeat\" with mpv, keep player running (@ritiek) (#660)\n- Display artist/album in mpris using lastfm (@vn-ki) (#739)\n- Use channel.list API for user search (@Razesdark) (#628)\n- Maintain volume across songs with mpv (@Razesdark) (#720)\n- Prevent mpris from crashing the main process (@hrnr) (#728)\n\nBug fixes:\n----------\n- Fix mpris seeking with recent mpv vesions (@mg6) (#687)\n- Fix removing video from multi-page playlist (@kraetzin) (#695)\n- Skip unavailable tracks (@ritiek) (#734)\n- Correctly display minutes/seconds (@Laxa) (#748)\n- Handle `null` time-pos from mpv (@pritambaral) (#519)\n- Fix da/dv command regex (@Vrihub) (#691)\n- Skip channels in video/playlist searches (@ritiek) (#664)\n- Fix divide by zero error (@ids1024) (#620)\n\nUse `git log v0.2.7.1..v0.2.8` to see all changes, including various minor\nfixes, documentation changes, etc. not included here.\n\n-------------------------------------------------------------------------------\n\nVersion 0.2.7.1\n6 July 2016\n\nBug fixes:\n----------\n- Fix pickle error (@ids1024) (#503)\n- Install LICENSE, README.md, and CHANGELOG as package_data (@ids1024)\n- Update youtube-dl in py2exe build (@ids1024)\n\n-------------------------------------------------------------------------------\n\nVersion 0.2.7\n27 June 2016\n\nFeatures:\n---------\n- Setting for default audio format (@nishanthkarthik) (#71 #466 #467)\n- Search history with `history` command (@kraetzin) (#344 #472)\n- Add syntax for repeating a track several times (@ghallak) (#437 #490)\n- Reverse command (@kraetzin) (#422 #473)\n- New `daurl ` command (@maricn) (#402)\n\nEnhancements:\n-------------\n- Pass `--no-ytdl` to mpv (@ids1024) (#492)\n- Do not suppress mpv output in debug mode (@ids1024)\n- Print traceback in debug mode (@ids1024)\n- Speed up `checkupdate` by avoiding redirects (@ids1024) (#454)\n- Pass `--play-and-exit` if vlc is used as a player (@ids1024)`\n\nBug fixes:\n----------\n- Fix error with python 3.3 (@ids1024) (#414)\n- Fix maxres bug (@ids1024) (#430)\n- Fix playlist cache bug in info command (@ids1024) (#468)\n- Fix usersearch argument error (@ids1024) (#469 #482)\n- Fix progress bar with new mpv versions (@ids1024) (#470 #485)\n- Fix syntax error with set command (@ids1024) (#419)\n- Fix syntax error with -w, -f, -a (@ids1024) (#420)\n- Fix clipboard support (@ids1024) (#461)\n- Fix mpv version checking on windows (@ids1024) (#397)\n- Add youtube_dl as dependency to Dockerfile (@PI-Victor) (#481)\n\nInternal api changes:\n---------------------\n- The code is now split between several files (@ids1024) (#208)\n- Add initial content api, for now only used for comments (@ids1024)\n- Begin documenting internal apis using sphinx (@ids1024)\n\n-------------------------------------------------------------------------------\n\nVersion 0.2.6\n1 January 2016\n\nFeatures:\n- Add browserplay command to play video in browser (rjvani) (#355 #390)\n- Make url command support multiple url, and allow loading urls from file\n (paulnicolet) (#90 #391)\n- Make youtube id available to download command (ids1024) (#375)\n- Make pagination work properly for all lists of songs (local playlists, etc.)\n and make them all support the dump command (ids1024) (#201)\n- Show warning when adding duplicate track to playlist (BensonQiu) (#374 #383)\n\nBug fixes:\n- Support playlists longer than 200 items (ids1024) (#192)\n- Make dapl download complete playlist (JKatzwinkel) (#294 #325)\n- Use pyperclip instead of xerox, fixing clipboard on linux (ids1024) (#311)\n- Fix error message on windows when video title has & (ids1024) (#321)\n- Run notifier command in background (hrnr) (#339)\n- Correctly handle -v option of play (TimoDritschler) (#352)\n- Make it possible to use a pager with --help (livingBEEF) (#349)\n- Allow mplayer for https streams if version is new enough\n (ids1024 Evidlo paddatrapper) (#315 #336 #317)\n- Use mpv.com instead of mpv.exe on windows (ids1024)\n\nInternal API changes:\n- Split code into several files (still a work in progress) (ids1024) (#208)\n- Use a python decorator to declare commands (ids1024)\n- Create a paginatesongs() function for handling the pagination and dump\n command uniformly as mentioned in features (#399) (ids1024)\n- Various others\n\nThere have been various other small bug fixes and internal API changes. Use\n`git log v0.2.5..0.2.6` to see all of them.\n\n-------------------------------------------------------------------------------\n\nVersion 0.2.5\n1 June 2015\n\n- Support python 3 only (will not run with python 2)\n- Fix progress bar bug on Windows (#215, #223)\n- Fix bug in playlist search (#282)\n- Add user_order setting for separate order of user searches (lol768) (#277)\n- Add mix command (lol768) (#241, #283)\n- Add page count with total number of pages and current page (JKatzwinkel)\n- Fix UnicodeEncodeError on non-unicode terminals\n- Install .desktop in setup.py so it does not have to be installed manually\n required for Ubuntu sound menu support\n\n-------------------------------------------------------------------------------\n\nVersion 0.2.4\n13 May 2015\n\n - Fix issue with rate-limiting in \"album\" command (#217)\n - Implement support for MPRIS (hrnr and ids1024) (#191, #210)\n - Fix display issue with small terminal width (#215)\n - Use version 3 of the youtube api (JKatzwinkel, ids1024, and lol768) (#256)\n version 2 was disabled by youtube and no longer works\n\n-------------------------------------------------------------------------------\n\nVersion 0.2.3\n17 February 2015\n\n - Fix issue with opening old playlist file (#214)\n - Fix issue with \"set\" command\n - Metadata tagging of downloaded audio files\n requires ffmpeg or avconv\n early implementation, uses YouTube video title, needs more work\n\n-------------------------------------------------------------------------------\n\nVersion 0.2.2\n14 February 2015\n\n- Implement skip to previous track (ids1024) #175 #18 #14\n Use > and < keys for next and prev track, q for quit (was ctrl-c)\n mpv / mplayer input.conf can be imported to use custom keymappings\n\n- Implement optional external download application (ids1024 and np1) #198 #132\n enter \"help dl-command\" for more info\n\n- Show stream quality on status line (Brebiche38) #134 #163\n\n- Implement support for creating Windows builds with py2exe (ids1024) #190\n Use setup.py in py2exe branch\n\n- Fix progress bar for mpv 0.7 (ids1024) #155 #161\n Resolves issues with playback looping\n\n- Fix mps-youtube does not run on FreeBSD (nivit)\n\n- Fix YouTube comments overshoot window size\n\n- Fix issue with audio remux when using `d` download command\n\n-------------------------------------------------------------------------------\n\nVersion 0.2.1\n27 November 2014\n\n[Bugfix] - Detect installed player on installation (#149)\n\n-------------------------------------------------------------------------------\n\nVersion 0.2.0\n25 November 2014\n\n- Auto detect terminal window size\n\n- Transcode audio to MP3 and other formats (requires ffmpeg or avconv)\n\n- Enabled da and dv commands for playlist search results\n\n- Added dapl and dvpl to download YouTube playlist audio/video\n by url/id to a separate subdirectory (mtahmed) #110\n\n- Progress indicator now works with mpv (previously only mplayer)\n\n- Added option to show system notifications (Alex Nisnevich) #95\n (can be used with libnotify - notify-send on linux)\n\n- Added overwrite true/false option for downloads (mtahmed) #93\n (skips download if downloaded file already exists)\n\n- Added copy to clipboard feature #97\n (requires python xerox module and xclip on linux or pywin32 on windows)\n\n- Remux audio downloads for better file compatibility (#135)\n\n[Bugfix] - Accept two-character length usernames (#99)\n\n[Bugfix] - Expand ~ character in download directory setting (punchagan)\n\n[Bugfix] - Don't truncate filename (YoussF) #122\n\n[Bugfix] - Exit with correct status code\n\n-------------------------------------------------------------------------------\n\nVersion 0.01.46\nMay 18 2014\n\n - Added c to view comments for a video\n (first 50 comments, no reply-comments)\n\n - Added feature to match album tracks using MusicBrainz (vixus0)\n To search albums, enter \"album\" optionally followed by album title\n\n - Custom formatted search result list using \"set columns\" command\n Optionally shows: rating, likes, dislikes, views, user, date, category\n and comments (number of) in search results\n\n - Added \"set order \" command for\n specifying search result ordering\n\n - Added \"set console-width\" for setting output width (default 80)\n\n - Added uploaded date in video info display (request #64)\n\n - Added likes / dislikes in video info display\n\n-------------------------------------------------------------------------------\n\nVersion 0.01.44\nMar 27 2014\n\n - Added max_res config item for selecting video resolution (request 56)\n - Added window_size and window_pos for selecting size / position of player\n - Improved handling of playlist file read/write (issue 66)\n - Revert to lower quality on unavailable/corrupt streams (issue 65)\n - Enabled multiple invocation commands (comma separated) (request 61)\n Eg: mpsyt //the doors, 1, shuffle, 1-3-a, quit\n - Improved url caching\n - Added shuffle command (no arguments, shuffles displayed items)\n - Handle 'video not available in your country' during multiple downloads\n - Fix UnicodeDecodeError in mplayer progress parsing (issue 58)\n - Fix UnicodeEncodeError under Windows with Python 2.7 (issue 59)\n\n-------------------------------------------------------------------------------\n\nVersion 0.01.41\nMar 14 2014\n\n - new configuration option, max_results - sets number of returned results\n (1 - 50)\n - pl now accepts YouTube playlist id's as well as url's\n - Fix error in download of .m4a files when mplayer is set as player.\n - Added option for downloading multiple items\n eg. da 1-4 or dv 3,5,6\n\n-------------------------------------------------------------------------------\n\nVersion 0.01.40\nMar 11 2014\n\n - Bugfix release, corrects UnicodeDecode error\n\n-------------------------------------------------------------------------------\n\nVersion 0.01.39\nMar 10 2014\n\nFeatures:\n - Added time / progress bar indicator. Big thanks to Thomas LÉVEIL!\n (mplayer only)\n - Added command to retrieve YouTube user playlists; \n userpl {username} or upl {username}\n - Added command to retrieve related videos; r{number}\n - playurl now respects -f, -w, and -a flags (fullscreen, window or audio)\n - Implemented input history persistence (uses readline, linux only)\n - Implemented non-interactive mode for command line invocation with playurl\n - Implemented less interactive mode for command line invocation with dlurl\n\nChanges:\n - // or .. prefix to search for YouTube playlists (was plsearch / pls)\n\nHelp / Documentation:\n - help will show relevant help topic page e.g., help dlurl\n - Documented configuration options (\"set\" commands)\n - Re-authored some help categories\n - Changed help to help , removed menu from help pages\n\nBugfixes\n - mplayer / mpv window now displays content title instead of url\n - Fixed issue with Python3 terminal output on playback ctrl-c interrupt\n - Fixed issue with debug mode not logging to file\n - Changed year format in YT playlist result screen to last two digits.\n (Under some environments it was showing 4-digit years)\n\n-------------------------------------------------------------------------------\n\nVersion 0.01.38\nMar 5 2014\n\n - Added i for YT playlist information display \n - Added stream url preloading for first item of opened YT playlists\n - Added last-updated date to YT playlist search result list \n - Fixed UnicodeError when run in non-UTF8 environments\n - Added more verbosity to --version command line option\n - Added --debug command line option (logs to /mpsyt.log)\n\n-------------------------------------------------------------------------------\n\nVersion 0.01.37\nMar 2 2014\n\n - Excluded YouTube paid videos from search results\n - Added \"pl \" command to open YouTube playlist url\n - Added \"plsearch \" command to search for YouTube playlists\n - Added \"dump\" command to show entire YT playlist (useful for saving locally)\n - Added \"undump\" command to undo dump (re-paginates YT playlist items)\n - Added \"u \" command to list uploads by uploader of \n - Added \"url \" command for retrieving a specific YT video\n - Added \"playurl \" command for directly playing a YT video\n - Added \"dlurl \" command for directly downloading a YT video\n - Changed command to list user uploads, new syntax is \"user \"\n - Added mpsyt --version flag for printing version info\n - Added mpsyt --help flag for printing help text\n - Fixed indentation bug when scrolling through readline history\n\n-------------------------------------------------------------------------------\n\nVersion 0.01.36\nFeb 27 2014\n\n - Wait for preloading item if it is selected while preloading\n - Fix bug where -a audio override is sometimes ignored\n\n-------------------------------------------------------------------------------\n\nVersion 0.01.35\nFeb 25 2014\n\n - Faster opening of audio streams with mpv \n (--demuxer-lavf-o=fflags=+ignid argument added for m4a streams)\n\n - Faster opening of audio streams with mplayer \n (reject m4a streams, prefer ogg streams)\n (fallback to video stream and suppress video when no ogg available)\n\n-------------------------------------------------------------------------------\n\nVersion 0.01.34\nFeb 22 2014\n\n - Fix bug: fails when no playlist file exists\n\n-------------------------------------------------------------------------------\n\nVersion 0.01.33\nFeb 22 2014\n\n - Changed structure of playlist file. Now consumes KB's rather than MB's\n - Same playlist file shared between Python2.7+ and Python3+ (was separate)\n - Improved display alignment for Russian text\n - Preload of url fails silently on unobtainable items (previously crashed)\n - Added prompt to mux audio on m4v download (experimental)\n\n-------------------------------------------------------------------------------\n\nVersion 0.01.32\nFeb 17 2014\n\n - Improve display alignment with certain unicode characters\n - Fix crash when using 'set' command on Windows (thomasleveil)\n\n-------------------------------------------------------------------------------\n\nVersion 0.01.31\nFeb 13 2014\n\n - Migrate location of config directory to reflect new name\n (~/.config/mps-youtube)\n\n"
},
{
"path": "CONTRIBUTING.md",
"content": "# Contributing for yewtube\n\nContributions are very much appreciated!\n\n* Pull requests should be based on and submitted to the \"develop\" branch.\n\n* Please raise an issue to discuss what you plan to implement or change before \nyou start if it is going to involve a lot of work on your part.\n\n* Please keep pull requests specific, do not make many disparate changes or\nnew features in one request. A separate pull request for each feature change\nis preferred.\n\n* Please ensure your changes work in Python 3.3+ and Windows.\n\n\n## Code conventions\n\n* Maximum line length is 80 characters\n\n* Follow the line-spacing style that is already in place.\n\n* Ensure all functions and classes have a PEP257 compliant docstring and the\ncode is PEP8 compliant.\n\n## Documentation\n\nInstall required extra docs package to setup mkdocs: `pip install -e \".[docs]\"`\n\nTo run built-in dev server: `mkdocs serve`\n\nTo deploy documentation to github page: `mkdocs gh-deploy`\n"
},
{
"path": "Dockerfile",
"content": "FROM python:3-stretch\n\nLABEL maintainer=\"Justin Garrison \" \\\n org.label-schema.schema-version=\"1.0\" \\\n org.label-schema.name=\"mps-youtube\" \\\n org.label-schema.description=\"Terminal based YouTube player and downloader \" \\\n org.label-schema.url=\"https://github.com/mps-youtube/mps-youtube/wiki\" \\\n org.label-schema.vcs-url=\"https://github.com/mps-youtube/mps-youtube\" \\\n org.label-schema.docker.cmd=\"docker run -v /dev/snd:/dev/snd -it --rm --privileged --name mpsyt mpsyt\"\n\nRUN DEBIAN_FRONTEND=noninteractive && \\\n apt-get update && \\\n apt-get install -y mplayer mpv && \\\n rm -rf /var/lib/apt/lists/* && \\\n apt-get clean && apt-get purge\n\nRUN pip install mps-youtube youtube-dl\n\nENTRYPOINT [\"mpsyt\"]\n"
},
{
"path": "ISSUE_TEMPLATE.md",
"content": "\n\n## Issue / Suggestion\n\n\n\n\n## Your Environment\n\n\n\n\n"
},
{
"path": "LICENSE",
"content": "GNU GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007 Free Software Foundation, Inc. {http://fsf.org/}\n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The GNU General Public License is a free, copyleft license for\nsoftware and other kinds of works.\n\n The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nthe GNU General Public License is intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users. We, the Free Software Foundation, use the\nGNU General Public License for most of our software; it applies also to\nany other work released this way by its authors. You can apply it to\nyour programs, too.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n To protect your rights, we need to prevent others from denying you\nthese rights or asking you to surrender the rights. Therefore, you have\ncertain responsibilities if you distribute copies of the software, or if\nyou modify it: responsibilities to respect the freedom of others.\n\n For example, if you distribute copies of such a program, whether\ngratis or for a fee, you must pass on to the recipients the same\nfreedoms that you received. You must make sure that they, too, receive\nor can get the source code. And you must show them these terms so they\nknow their rights.\n\n Developers that use the GNU GPL protect your rights with two steps:\n(1) assert copyright on the software, and (2) offer you this License\ngiving you legal permission to copy, distribute and/or modify it.\n\n For the developers' and authors' protection, the GPL clearly explains\nthat there is no warranty for this free software. For both users' and\nauthors' sake, the GPL requires that modified versions be marked as\nchanged, so that their problems will not be attributed erroneously to\nauthors of previous versions.\n\n Some devices are designed to deny users access to install or run\nmodified versions of the software inside them, although the manufacturer\ncan do so. This is fundamentally incompatible with the aim of\nprotecting users' freedom to change the software. The systematic\npattern of such abuse occurs in the area of products for individuals to\nuse, which is precisely where it is most unacceptable. Therefore, we\nhave designed this version of the GPL to prohibit the practice for those\nproducts. If such problems arise substantially in other domains, we\nstand ready to extend this provision to those domains in future versions\nof the GPL, as needed to protect the freedom of users.\n\n Finally, every program is threatened constantly by software patents.\nStates should not allow patents to restrict development and use of\nsoftware on general-purpose computers, but in those that do, we wish to\navoid the special danger that patents applied to a free program could\nmake it effectively proprietary. To prevent this, the GPL assures that\npatents cannot be used to render the program non-free.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n TERMS AND CONDITIONS\n\n 0. Definitions.\n\n \"This License\" refers to version 3 of the GNU General Public License.\n\n \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n \"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n 1. Source Code.\n\n The \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.\n\n A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n The Corresponding Source for a work in source code form is that\nsame work.\n\n 2. Basic Permissions.\n\n All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n Conveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n 4. Conveying Verbatim Copies.\n\n You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n 5. Conveying Modified Source Versions.\n\n You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n a) The work must carry prominent notices stating that you modified\n it, and giving a relevant date.\n\n b) The work must carry prominent notices stating that it is\n released under this License and any conditions added under section\n 7. This requirement modifies the requirement in section 4 to\n \"keep intact all notices\".\n\n c) You must license the entire work, as a whole, under this\n License to anyone who comes into possession of a copy. This\n License will therefore apply, along with any applicable section 7\n additional terms, to the whole of the work, and all its parts,\n regardless of how they are packaged. This License gives no\n permission to license the work in any other way, but it does not\n invalidate such permission if you have separately received it.\n\n d) If the work has interactive user interfaces, each must display\n Appropriate Legal Notices; however, if the Program has interactive\n interfaces that do not display Appropriate Legal Notices, your\n work need not make them do so.\n\n A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n 6. Conveying Non-Source Forms.\n\n You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n a) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by the\n Corresponding Source fixed on a durable physical medium\n customarily used for software interchange.\n\n b) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by a\n written offer, valid for at least three years and valid for as\n long as you offer spare parts or customer support for that product\n model, to give anyone who possesses the object code either (1) a\n copy of the Corresponding Source for all the software in the\n product that is covered by this License, on a durable physical\n medium customarily used for software interchange, for a price no\n more than your reasonable cost of physically performing this\n conveying of source, or (2) access to copy the\n Corresponding Source from a network server at no charge.\n\n c) Convey individual copies of the object code with a copy of the\n written offer to provide the Corresponding Source. This\n alternative is allowed only occasionally and noncommercially, and\n only if you received the object code with such an offer, in accord\n with subsection 6b.\n\n d) Convey the object code by offering access from a designated\n place (gratis or for a charge), and offer equivalent access to the\n Corresponding Source in the same way through the same place at no\n further charge. You need not require recipients to copy the\n Corresponding Source along with the object code. If the place to\n copy the object code is a network server, the Corresponding Source\n may be on a different server (operated by you or a third party)\n that supports equivalent copying facilities, provided you maintain\n clear directions next to the object code saying where to find the\n Corresponding Source. Regardless of what server hosts the\n Corresponding Source, you remain obligated to ensure that it is\n available for as long as needed to satisfy these requirements.\n\n e) Convey the object code using peer-to-peer transmission, provided\n you inform other peers where the object code and Corresponding\n Source of the work are being offered to the general public at no\n charge under subsection 6d.\n\n A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n 7. Additional Terms.\n\n \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n a) Disclaiming warranty or limiting liability differently from the\n terms of sections 15 and 16 of this License; or\n\n b) Requiring preservation of specified reasonable legal notices or\n author attributions in that material or in the Appropriate Legal\n Notices displayed by works containing it; or\n\n c) Prohibiting misrepresentation of the origin of that material, or\n requiring that modified versions of such material be marked in\n reasonable ways as different from the original version; or\n\n d) Limiting the use for publicity purposes of names of licensors or\n authors of the material; or\n\n e) Declining to grant rights under trademark law for use of some\n trade names, trademarks, or service marks; or\n\n f) Requiring indemnification of licensors and authors of that\n material by anyone who conveys the material (or modified versions of\n it) with contractual assumptions of liability to the recipient, for\n any liability that these contractual assumptions directly impose on\n those licensors and authors.\n\n All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n 8. Termination.\n\n You may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n 9. Acceptance Not Required for Having Copies.\n\n You are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n 10. Automatic Licensing of Downstream Recipients.\n\n Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.\n\n An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n 11. Patents.\n\n A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".\n\n A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n 12. No Surrender of Others' Freedom.\n\n If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n 13. Use with the GNU Affero General Public License.\n\n Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU Affero General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the special requirements of the GNU Affero General Public License,\nsection 13, concerning interaction through a network will apply to the\ncombination as such.\n\n 14. Revised Versions of this License.\n\n The Free Software Foundation may publish revised and/or new versions of\nthe GNU General Public License from time to time. Such new versions will\nbe similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n Each version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n If the Program specifies that a proxy can decide which future\nversions of the GNU General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n Later license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n 15. Disclaimer of Warranty.\n\n THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n 16. Limitation of Liability.\n\n IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n 17. Interpretation of Sections 15 and 16.\n\n If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n\n If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n To do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n {one line to give the program's name and a brief idea of what it does.}\n Copyright (C) {year} {name of author}\n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU General Public License for more details.\n\n You should have received a copy of the GNU General Public License\n along with this program. If not, see {http://www.gnu.org/licenses/}.\n\nAlso add information on how to contact you by electronic and paper mail.\n\n If the program does terminal interaction, make it output a short\nnotice like this when it starts in an interactive mode:\n\n Copyright (C) \n This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.\n This is free software, and you are welcome to redistribute it\n under certain conditions; type `show c' for details.\n\nThe hypothetical commands `show w' and `show c' should show the appropriate\nparts of the General Public License. Of course, your program's commands\nmight be different; for a GUI interface, you would use an \"about box\".\n\n You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU GPL, see\n{http://www.gnu.org/licenses/}.\n\n The GNU General Public License does not permit incorporating your program\ninto proprietary programs. If your program is a subroutine library, you\nmay consider it more useful to permit linking proprietary applications with\nthe library. If this is what you want to do, use the GNU Lesser General\nPublic License instead of this License. But first, please read\n{http://www.gnu.org/philosophy/why-not-lgpl.html}.\n"
},
{
"path": "MANIFEST.in",
"content": "include mps-youtube.desktop\ninclude LICENSE\ninclude README.md\ninclude CHANGELOG.md\n"
},
{
"path": "README.md",
"content": "\n \n\n
\n\n\n Terminal based YouTube player and downloader. No Youtube API key required. Forked from mps-youtube \n\nInstallation\n-----------\n# Stable Version\n\n### Using pip\n1. Install using `pip install yewtube`\n2. Run using, `yt`. Enjoy! \n\n### Using pipx (Recommended)\n1. Install **_pipx_** using `pip install pipx`\n2. Install `yewtube` using `pipx install yewtube`\n3. Now, type `yt` That's it.\n\n# Latest Version\n\n### Using pip\n1. Install using `pip install git+https://github.com/iamtalhaasghar/yewtube.git`\n2. Run using, `yt`. Enjoy! \n\n### Using pipx\n1. Install **_pipx_** using `pip install pipx`\n2. Install `yewtube` using `pipx install git+https://github.com/iamtalhaasghar/yewtube.git`\n3. Now, type `yt` That's it.\n\nWhat's new in yewtube?\n----------------------\n- **No Youtube API Key required**\n- **Run audio in VLC with no GUI**\n\nSee complete and up-to-date changelog [here](https://github.com/iamtalhaasghar/yewtube/blob/master/CHANGELOG.md).\n\nThese features are still inherited from [mps-youtube](https://github.com/mps-youtube/mps-youtube).\n- Search and play audio/video from YouTube\n- Search tracks of albums by album title\n- Search and import YouTube playlists\n- Create and save local playlists\n- Download audio/video\n- Convert to mp3 & other formats (requires ffmpeg or avconv)\n- View video comments\n- Works with Python 3.x\n- Works with Windows, Linux and Mac OS X\n- Requires mplayer, mpv or VLC\n\nThis project is based on [mps-youtube](https://github.com/mps-youtube/mps-youtube) and mps-youtube is based on [mps](https://web.archive.org/web/20180429034221/https://github.com/np1/mps), a terminal based program to search, stream and download music. This\nimplementation uses YouTube as a source of content and can play and\ndownload video as well as audio. The [pafy](https://github.com/mps-youtube/pafy) library handles interfacing with YouTube.\n\n[mps-youtube wiki](https://github.com/mps-youtube/mps-youtube/wiki/Troubleshooting) \n[yewtube wiki](https://github.com/iamtalhaasghar/yewtube/wiki/FAQ)\n\nScreenshots\n-----------\n\nSearch: \n\n\nA standard search is performed by entering `/` followed by search terms.\n\nYou can play all of the search results by giving `1-` as input\n\nRepeating song/songs can be done with `song_number[loop]`, for example:\n`1[3]` or `4-6[2]`\n\nLocal Playlists: \n\n\nSearch result items can easily be stored in local playlists.\n\nYouTube Playlists: \n\n\nYouTube playlists can be searched and played or saved as local\nplaylists.\n\nA playlist search is performed by `//` followed by search term.\n\nDownload: \n\n\nContent can be downloaded in various formats and resolutions.\n\nComments: \n\n\nA basic comments browser is available to view YouTube user comments.\n\nMusic Album Matching: \n\n\n\n\n\nAn album title can be specified and yewtube will attempt to find\nmatches for each track of the album, based on title and duration. Type\n`help search` for more info.\n\nCustomisation: \n\n\n\nSearch results can be customised to display additional fields and\nordered by various criteria.\n\nThis configuration was set up using the following commands\n```\nset order views\nset columns user:14 date comments rating likes dislikes category:9 views\n```\n\nType `help config` for help on configuration options\n\nUpgrading\n---------\n\n### If installed using pipx\n\n` pipx upgrade yewtube `\n\n### If installed using pip\n\n`pip install --upgrade yewtube`\n\nUsage\n-----\n\nyewtube is run on the command line using the command:\n\n `yt`\n\nEnter `h` from within the program for help.\n\n\nUsing yewtube with mpris\n------------------------\n\n1. Install PyGObject, GTK and their dependencies based on this guide https://pygobject.readthedocs.io/en/latest/getting_started.html\n2. Install yewtube with mpris extra\n\n```shell\n> # recommended\n> pipx install 'yewtube[mpris]'\n> # or\n> pip install 'yewtube[mpris]'\n```\n\n3. check yewtube version\n\n```shell\n> yt --version\nyewtube version : 2.8.2\nyt_dlp version : 2022.02.04\nPython version : 3.9.7 (default, Nov 7 2021, 15:17:57)\n[GCC 11.2.0]\nProcessor : x86_64\nMachine type : x86_64\nArchitecture : 64bit, ELF\nPlatform : Linux-5.13.0-35-generic-x86_64-with-glibc2.34\nsys.stdout.enc : utf-8\ndefault enc : utf-8\nConfig dir : /home/user/.config/mps-youtube\ndbus : 1.2.18\nglib : True\nenv:TERM : tmux-256color\nenv:SHELL : /usr/bin/zsh\nenv:LANG : en_US.UTF-8\n```\n\nIf everything working correctly, dbug and glib would have similar result as above text\n\n4. run `set mpris true` on yewtube\n5. check with `playerctl`\n\n```shell\n> playerctl -l\nmps-youtube.instance567867\n```\n\nCheck also the [common-issue](https://github.com/iamtalhaasghar/yewtube/wiki/Common-issues) if you are having problem with yewtube.\n\nHow to Contribute\n-----------------\n\nContributions are welcomed! However, please check out the [contribution page](https://github.com/iamtalhaasghar/yewtube/blob/master/CONTRIBUTING.md) before making a contribution.\n"
},
{
"path": "RELEASING.md",
"content": "Release process for pafy and mps-youtube\n========================================\n\nLooking at the commits and Github releases for previous versions can provide an example.\n\nVersion numbers\n---------------\n### pafy\nBump the `__version__` in `__init__.py`.\n\n### mps-youtube\nBump the `version` in `VERSION`, `__version__` and `__notes__` in `__init__.py`, and `VERSION` in `setup.py`.\n\nChangelogs\n----------\nUpdate `CHANGELOG` with a summary of changes since the last release. `git shortlog` can be helpful to see what commits have occurred.\n\n### mps-youtube\nAlso update `New Features` in `helptext.py`. This help section has ended up falling out of date. If it isn't kept up to date, it should probably be removed.\n\nGithub Release\n--------------\nCreate a release through the Github website, tagging the commit that should be released. The text from the `CHANGELOG` should be copied to the release.\n\npy2exe\n------\nFor mps-youtube, a `.exe` file should be built with `python setup.py py2exe` under Windows. Make sure the correct pafy and youtube-dl versions are being used, since they will be embedded in the binary. Attach this file to the Github release.\n\nPyPI\n----\nPush the source, and a wheel build, to PyPI. Be careful that everything is correct at this point; PyPI does not allow replacing an uploaded file with a different one of the same name.\n\nGPG Signatures\n--------------\nThe `.tar.gz` signatures for `pafy` and `mps-youtube` also have GPG signatures attached to the release. Currently, they are signed with @ids1024's key, so only he can perform this step.\n\nPossible Simplifications to this Process\n----------------------------------------\nThe New Features help text isn't really important, but it is genuinely nice to have if kept up to date.\n\nPerhaps the `CHANGELOG` file isn't really needed, if Github releases includes that information.\n"
},
{
"path": "_config.yml",
"content": "theme: jekyll-theme-hacker"
},
{
"path": "doc/conf.py",
"content": "#!/usr/bin/env python3\n# -*- coding: utf-8 -*-\n#\n# mps_youtube documentation build configuration file, created by\n# sphinx-quickstart on Mon Apr 18 17:35:31 2016.\n#\n# This file is execfile()d with the current directory set to its\n# containing dir.\n#\n# Note that not all possible configuration values are present in this\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\nimport sys\nimport os\nimport sphinx_rtd_theme\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\n#sys.path.insert(0, os.path.abspath('.'))\n\n# -- General configuration ------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n 'sphinx.ext.autodoc',\n 'sphinx.ext.todo',\n]\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = ['_templates']\n\n# The suffix(es) of source filenames.\n# You can specify multiple suffix as a list of string:\n# source_suffix = ['.rst', '.md']\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8-sig'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = 'mps_youtube'\ncopyright = '2016, mps-youtube developers'\nauthor = 'mps-youtube developers'\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = ''\n# The full version, including alpha/beta/rc tags.\nrelease = ''\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#\n# This is also used if you do content translation via gettext catalogs.\n# Usually you set \"language\" from the command line for these cases.\nlanguage = 'en'\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\n# This patterns also effect to html_static_path and html_extra_path\nexclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']\n\n# The reST default role (used for this markup: `text`) to use for all\n# documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\n# If true, keep warnings as \"system message\" paragraphs in the built documents.\n#keep_warnings = False\n\n# If true, `todo` and `todoList` produce output, else they produce nothing.\ntodo_include_todos = True\n\n\n# -- Options for HTML output ----------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. See the documentation for\n# a list of builtin themes.\n#html_theme = 'alabaster'\nhtml_theme = \"sphinx_rtd_theme\"\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further. For a list of options available for each theme, see the\n# documentation.\n#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\nhtml_theme_path = [sphinx_rtd_theme.get_html_theme_path()]\n\n# The name for this set of Sphinx documents.\n# \" v documentation\" by default.\n#html_title = 'mps_youtube v'\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#html_logo = None\n\n# The name of an image file (relative to this directory) to use as a favicon of\n# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#html_favicon = None\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = ['_static']\n\n# Add any extra paths that contain custom files (such as robots.txt or\n# .htaccess) here, relative to this directory. These files are copied\n# directly to the root of the documentation.\n#html_extra_path = []\n\n# If not None, a 'Last updated on:' timestamp is inserted at every page\n# bottom, using the given strftime format.\n# The empty string is equivalent to '%b %d, %Y'.\n#html_last_updated_fmt = None\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {}\n\n# If false, no module index is generated.\n#html_domain_indices = True\n\n# If false, no index is generated.\n#html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, \"Created using Sphinx\" is shown in the HTML footer. Default is True.\n#html_show_sphinx = True\n\n# If true, \"(C) Copyright ...\" is shown in the HTML footer. Default is True.\n#html_show_copyright = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# This is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = None\n\n# Language to be used for generating the HTML full-text search index.\n# Sphinx supports the following languages:\n# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'\n# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'\n#html_search_language = 'en'\n\n# A dictionary with options for the search language support, empty by default.\n# 'ja' uses this config value.\n# 'zh' user can custom change `jieba` dictionary path.\n#html_search_options = {'type': 'default'}\n\n# The name of a javascript file (relative to the configuration directory) that\n# implements a search results scorer. If empty, the default will be used.\n#html_search_scorer = 'scorer.js'\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'mps_youtubedoc'\n\n# -- Options for LaTeX output ---------------------------------------------\n\nlatex_elements = {\n# The paper size ('letterpaper' or 'a4paper').\n#'papersize': 'letterpaper',\n\n# The font size ('10pt', '11pt' or '12pt').\n#'pointsize': '10pt',\n\n# Additional stuff for the LaTeX preamble.\n#'preamble': '',\n\n# Latex figure (float) alignment\n#'figure_align': 'htbp',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title,\n# author, documentclass [howto, manual, or own class]).\nlatex_documents = [\n (master_doc, 'mps_youtube.tex', 'mps\\\\_youtube Documentation',\n 'Author', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# If true, show page references after internal links.\n#latex_show_pagerefs = False\n\n# If true, show URL addresses after external links.\n#latex_show_urls = False\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_domain_indices = True\n\n\n# -- Options for manual page output ---------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\nman_pages = [\n (master_doc, 'mps_youtube', 'mps_youtube Documentation',\n [author], 1)\n]\n\n# If true, show URL addresses after external links.\n#man_show_urls = False\n\n\n# -- Options for Texinfo output -------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n# dir menu entry, description, category)\ntexinfo_documents = [\n (master_doc, 'mps_youtube', 'mps_youtube Documentation',\n author, 'mps_youtube', 'One line description of project.',\n 'Miscellaneous'),\n]\n\n# Documents to append as an appendix to all manuals.\n#texinfo_appendices = []\n\n# If false, no module index is generated.\n#texinfo_domain_indices = True\n\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\n#texinfo_show_urls = 'footnote'\n\n# If true, do not generate a @detailmenu in the \"Top\" node's menu.\n#texinfo_no_detailmenu = False\n\n\n# -- Options for Epub output ----------------------------------------------\n\n# Bibliographic Dublin Core info.\nepub_title = project\nepub_author = author\nepub_publisher = author\nepub_copyright = copyright\n\n# The basename for the epub file. It defaults to the project name.\n#epub_basename = project\n\n# The HTML theme for the epub output. Since the default themes are not\n# optimized for small screen space, using the same theme for HTML and epub\n# output is usually not wise. This defaults to 'epub', a theme designed to save\n# visual space.\n#epub_theme = 'epub'\n\n# The language of the text. It defaults to the language option\n# or 'en' if the language is not set.\n#epub_language = ''\n\n# The scheme of the identifier. Typical schemes are ISBN or URL.\n#epub_scheme = ''\n\n# The unique identifier of the text. This can be a ISBN number\n# or the project homepage.\n#epub_identifier = ''\n\n# A unique identification for the text.\n#epub_uid = ''\n\n# A tuple containing the cover image and cover page html template filenames.\n#epub_cover = ()\n\n# A sequence of (type, uri, title) tuples for the guide element of content.opf.\n#epub_guide = ()\n\n# HTML files that should be inserted before the pages created by sphinx.\n# The format is a list of tuples containing the path and title.\n#epub_pre_files = []\n\n# HTML files that should be inserted after the pages created by sphinx.\n# The format is a list of tuples containing the path and title.\n#epub_post_files = []\n\n# A list of files that should not be packed into the epub file.\nepub_exclude_files = ['search.html']\n\n# The depth of the table of contents in toc.ncx.\n#epub_tocdepth = 3\n\n# Allow duplicate toc entries.\n#epub_tocdup = True\n\n# Choose between 'default' and 'includehidden'.\n#epub_tocscope = 'default'\n\n# Fix unsupported image types using the Pillow.\n#epub_fix_images = False\n\n# Scale large images.\n#epub_max_image_width = 0\n\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\n#epub_show_urls = 'inline'\n\n# If false, no index is generated.\n#epub_use_index = True\n"
},
{
"path": "doc/index.rst",
"content": ".. mps_youtube documentation master file, created by\n sphinx-quickstart on Mon Apr 18 17:35:31 2016.\n You can adapt this file completely to your liking, but it should at least\n contain the root `toctree` directive.\n\nAPI Documentation for mps_youtube\n=================================\n\nContents:\n\n.. toctree::\n mps_youtube\n\n\nIndices and tables\n==================\n\n* :ref:`genindex`\n* :ref:`modindex`\n* :ref:`search`\n\n"
},
{
"path": "doc/modules.rst",
"content": "mps_youtube\n===========\n\n.. toctree::\n :maxdepth: 4\n\n mps_youtube\n"
},
{
"path": "doc/mps_youtube.c.rst",
"content": "mps_youtube.c module\n====================\n\n.. automodule:: mps_youtube.c\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.cache.rst",
"content": "mps_youtube.cache module\n========================\n\n.. automodule:: mps_youtube.cache\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.commands.album_search.rst",
"content": "mps_youtube.commands.album_search module\n========================================\n\n.. automodule:: mps_youtube.commands.album_search\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.commands.config.rst",
"content": "mps_youtube.commands.config module\n==================================\n\n.. automodule:: mps_youtube.commands.config\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.commands.download.rst",
"content": "mps_youtube.commands.download module\n====================================\n\n.. automodule:: mps_youtube.commands.download\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.commands.local_playlist.rst",
"content": "mps_youtube.commands.local_playlist module\n==========================================\n\n.. automodule:: mps_youtube.commands.local_playlist\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.commands.misc.rst",
"content": "mps_youtube.commands.misc module\n================================\n\n.. automodule:: mps_youtube.commands.misc\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.commands.play.rst",
"content": "mps_youtube.commands.play module\n================================\n\n.. automodule:: mps_youtube.commands.play\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.commands.rst",
"content": "mps_youtube.commands package\n============================\n\nSubmodules\n----------\n\n.. toctree::\n\n mps_youtube.commands.album_search\n mps_youtube.commands.config\n mps_youtube.commands.download\n mps_youtube.commands.local_playlist\n mps_youtube.commands.misc\n mps_youtube.commands.play\n mps_youtube.commands.search\n mps_youtube.commands.songlist\n\nModule contents\n---------------\n\n.. automodule:: mps_youtube.commands\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.commands.search.rst",
"content": "mps_youtube.commands.search module\n==================================\n\n.. automodule:: mps_youtube.commands.search\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.commands.songlist.rst",
"content": "mps_youtube.commands.songlist module\n====================================\n\n.. automodule:: mps_youtube.commands.songlist\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.config.rst",
"content": "mps_youtube.config module\n=========================\n\n.. automodule:: mps_youtube.config\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.content.rst",
"content": "mps_youtube.content module\n==========================\n\n.. automodule:: mps_youtube.content\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.g.rst",
"content": "mps_youtube.g module\n====================\n\n.. automodule:: mps_youtube.g\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.helptext.rst",
"content": "mps_youtube.helptext module\n===========================\n\n.. automodule:: mps_youtube.helptext\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.history.rst",
"content": "mps_youtube.history module\n==========================\n\n.. automodule:: mps_youtube.history\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.init.rst",
"content": "mps_youtube.init module\n=======================\n\n.. automodule:: mps_youtube.init\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.main.rst",
"content": "mps_youtube.main module\n=======================\n\n.. automodule:: mps_youtube.main\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.mpris.rst",
"content": "mps_youtube.mpris module\n========================\n\n.. automodule:: mps_youtube.mpris\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.paths.rst",
"content": "mps_youtube.paths module\n========================\n\n.. automodule:: mps_youtube.paths\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.player.rst",
"content": "mps_youtube.player module\n=========================\n\n.. automodule:: mps_youtube.player\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.playlist.rst",
"content": "mps_youtube.playlist module\n===========================\n\n.. automodule:: mps_youtube.playlist\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.playlists.rst",
"content": "mps_youtube.playlists module\n============================\n\n.. automodule:: mps_youtube.playlists\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.rst",
"content": "mps_youtube package\n===================\n\nSubpackages\n-----------\n\n.. toctree::\n\n mps_youtube.commands\n\nSubmodules\n----------\n\n.. toctree::\n\n mps_youtube.c\n mps_youtube.cache\n mps_youtube.config\n mps_youtube.content\n mps_youtube.g\n mps_youtube.helptext\n mps_youtube.history\n mps_youtube.init\n mps_youtube.main\n mps_youtube.mpris\n mps_youtube.paths\n mps_youtube.player\n mps_youtube.playlist\n mps_youtube.playlists\n mps_youtube.screen\n mps_youtube.streams\n mps_youtube.terminalsize\n mps_youtube.util\n\nModule contents\n---------------\n\n.. automodule:: mps_youtube\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.screen.rst",
"content": "mps_youtube.screen module\n=========================\n\n.. automodule:: mps_youtube.screen\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.streams.rst",
"content": "mps_youtube.streams module\n==========================\n\n.. automodule:: mps_youtube.streams\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.terminalsize.rst",
"content": "mps_youtube.terminalsize module\n===============================\n\n.. automodule:: mps_youtube.terminalsize\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "doc/mps_youtube.util.rst",
"content": "mps_youtube.util module\n=======================\n\n.. automodule:: mps_youtube.util\n :members:\n :undoc-members:\n :show-inheritance:\n"
},
{
"path": "docs/changelog.md",
"content": "--8<-- \"CHANGELOG.md\"\n"
},
{
"path": "docs/contributing.md",
"content": "--8<-- \"CONTRIBUTING.md\"\n"
},
{
"path": "docs/css/mkdocstrings.css",
"content": "/* Indentation. */\ndiv.doc-contents:not(.first) {\n padding-left: 25px;\n border-left: 4px solid rgba(230, 230, 230);\n margin-bottom: 80px;\n}\n\n/* Don't capitalize names. */\nh5.doc-heading {\n text-transform: none !important;\n}\n\n/* Don't use vertical space on hidden ToC entries. */\n.hidden-toc::before {\n margin-top: 0 !important;\n padding-top: 0 !important;\n}\n\n/* Don't show permalink of hidden ToC entries. */\n.hidden-toc a.headerlink {\n display: none;\n}\n\n/* Avoid breaking parameters name, etc. in table cells. */\ntd code {\n word-break: normal !important;\n}\n\n/* For pieces of Markdown rendered in table cells. */\ntd p {\n margin-top: 0 !important;\n margin-bottom: 0 !important;\n}\n"
},
{
"path": "docs/gen_ref_nav.py",
"content": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n\"\"\"Generate the code reference pages and navigation.\"\"\"\n\nfrom pathlib import Path\n\nimport mkdocs_gen_files\n\nnav = mkdocs_gen_files.Nav()\n\nskip_files = [\n (Path(\"mps_youtube\") / \"config.py\"),\n (Path(\"mps_youtube\") / \"mpris.py\"),\n]\nskip_files.extend((Path(\"mps_youtube\") / \"test\").glob(\"*.py\"))\nfor path in sorted(Path(\"mps_youtube\").glob(\"**/*.py\")):\n if path in skip_files:\n continue\n module_path = path.with_suffix(\"\")\n doc_path = path.relative_to(\"mps_youtube\").with_suffix(\".md\")\n full_doc_path = Path(\"reference\", doc_path)\n\n parts = list(module_path.parts)\n parts[-1] = f\"{parts[-1]}.py\"\n nav[parts] = doc_path\n\n with mkdocs_gen_files.open(full_doc_path, \"w\") as fd:\n ident = \".\".join(module_path.parts)\n print(\"::: \" + ident, file=fd)\n\n mkdocs_gen_files.set_edit_path(full_doc_path, path)\n\nwith mkdocs_gen_files.open(\"reference/SUMMARY.md\", \"w\") as nav_file:\n nav_file.writelines(nav.build_literate_nav())\n"
},
{
"path": "docs/index.md",
"content": "--8<-- \"README.md\"\n"
},
{
"path": "docs/license.md",
"content": "```\n--8<-- \"LICENSE\"\n```\n"
},
{
"path": "mkdocs.yml",
"content": "site_name: Yewtube\nsite_description: Terminal based YouTube player and downloader.\nsite_url: https://iamtalhaasghar.github.io/yewtube\nrepo_url: https://github.com/iamtalhaasghar/yewtube\nrepo_name: iamtalhaasghar/yewtube\n\nnav:\n- Home:\n - Overview: index.md\n - Changelog: changelog.md\n - License: license.md\n- Code Reference: reference/\n- Development:\n - Contributing: contributing.md\n\ntheme:\n name: material\n features:\n - navigation.tabs\n palette:\n scheme: slate\n primary: teal\n accent: purple\n\nextra_css:\n- css/mkdocstrings.css\n\nmarkdown_extensions:\n- admonition\n- pymdownx.emoji\n- pymdownx.magiclink\n- pymdownx.snippets:\n check_paths: true\n- pymdownx.superfences\n- pymdownx.tabbed\n- pymdownx.tasklist\n- toc:\n permalink: true\n\nplugins:\n- search\n- mkdocstrings:\n watch:\n - mps_youtube\n- gen-files:\n scripts:\n - docs/gen_ref_nav.py\n- literate-nav:\n nav_file: SUMMARY.md\n"
},
{
"path": "mps_youtube/__init__.py",
"content": "from pip._vendor import pkg_resources\n\n__version__ = next((p.version for p in pkg_resources.working_set if p.project_name.lower() == 'yewtube'), \"unable to determine\")\n__author__ = \"iamtalhaasghar\"\n__license__ = \"GPLv3\"\n__url__ = \"https://github.com/iamtalhaasghar/yewtube\"\n\n"
},
{
"path": "mps_youtube/c.py",
"content": "\"\"\" Module for holding colour code values. \"\"\"\n\nimport os\nimport re\nimport sys\n\n\nif sys.stdout.isatty():\n white = \"\\x1b[%sm\" % 0\n ul = \"\\x1b[%sm\" * 3 % (2, 4, 33)\n cols = [\"\\x1b[%sm\" % n for n in range(91, 96)]\n red, green, yellow, blue, pink = cols\nelse:\n ul = red = green = yellow = blue = pink = white = \"\"\n\nr, g, y, b, p, w = red, green, yellow, blue, pink, white\n\nansirx = re.compile(r'\\x1b\\[\\d*m', re.UNICODE)\n\ndef c(colour, text):\n \"\"\" Return coloured text. \"\"\"\n colours = {'r': r, 'g': g, 'y': y, 'b':b, 'p':p}\n return colours[colour] + text + w\n\ndef charcount(s):\n \"\"\" Return number of characters in string, with ANSI color codes excluded. \"\"\"\n return len(ansirx.sub('', s))\n"
},
{
"path": "mps_youtube/cache.py",
"content": "import os\nimport pickle\n\n\nfrom . import g, c, streams\nfrom .util import dbg\n\n\n# Updated every time incompatible changes are made to cache format,\n# So old cache can be dropped\nCACHE_VERSION = 1\n\ndef load():\n \"\"\" Import cache file. \"\"\"\n if os.path.isfile(g.CACHEFILE):\n\n try:\n\n with open(g.CACHEFILE, \"rb\") as cf:\n cached = pickle.load(cf)\n\n # Note: will be none for yewtube 0.2.5 or earlier\n version = cached.get('version')\n\n if 'streams' in cached:\n if version and version >= 1:\n g.streams = cached['streams']\n g.username_query_cache = cached['userdata']\n else:\n g.streams = cached\n\n if 'pafy' in cached:\n pass\n #pafy.load_cache(cached['pafy'])\n\n dbg(c.g + \"%s cached streams imported%s\", str(len(g.streams)), c.w)\n\n except (EOFError, IOError):\n dbg(c.r + \"Cache file failed to open\" + c.w)\n\n streams.prune()\n\n\ndef save():\n \"\"\" Save stream cache. \"\"\"\n caches = dict(\n version=CACHE_VERSION,\n streams=g.streams,\n userdata=g.username_query_cache\n #,pafy=pafy.dump_cache()\n )\n\n with open(g.CACHEFILE, \"wb\") as cf:\n pickle.dump(caches, cf, protocol=2)\n\n dbg(c.p + \"saved cache file: \" + g.CACHEFILE + c.w)\n"
},
{
"path": "mps_youtube/commands/__init__.py",
"content": "import collections\nimport re\n\nfrom .. import g\nfrom ..main import completer\n\nCommand = collections.namedtuple('Command', 'regex category usage function')\n\n# input types\nWORD = r'[^\\W\\d][-\\w\\s]{,100}'\nRS = r'(?:(?:repeat|shuffle|-[avfw])\\s*)'\nPL = r'\\S*?((?:RD|PL|LL|UU|FL|OL)[-_0-9a-zA-Z]+)\\s*'\n\n## @command decorator\n##\n## The @command decorator takes a single regex followed by one or more\n## strings that corresponds to command names that will be added to\n## the tab completion.\n##\n## If your command has short-forms, only register the longer\n## forms.\n## If you use several functions and regexes for the same command but different\n## arguments, append the completion string on EACH function, not only\n## the first time you register it.\ndef command(regex, *commands):\n \"\"\" Decorator to register an mps-youtube command. \"\"\"\n for command in commands:\n completer.add_cmd(command)\n def decorator(function):\n cmd = Command(re.compile(regex), None, None, function)\n g.commands.append(cmd)\n return function\n return decorator\n\n\n# Placed at bottom to deal with cyclic imports\nfrom . import download, search, album_search, spotify_playlist, misc, config, local_playlist\nfrom . import play, songlist, generate_playlist, lastfm\n"
},
{
"path": "mps_youtube/commands/album_search.py",
"content": "import re\nimport time\nimport difflib\nfrom urllib.request import build_opener\nfrom urllib.error import HTTPError, URLError\nfrom urllib.parse import urlencode\nfrom xml.etree import ElementTree as ET\n\n\nfrom .. import c, g, screen, __version__, __url__, config, util, pafy\nfrom .. import content as content_py\nfrom . import command\nfrom .songlist import paginatesongs\nfrom .search import get_tracks_from_json\n\n\ndef show_message(message, col=c.r, update=False):\n \"\"\" Show message using col, update screen if required. \"\"\"\n g.content = content_py.generate_songlist_display()\n g.message = col + message + c.w\n\n if update:\n screen.update()\n\n\ndef _do_query(url, query, err='query failed', report=False):\n \"\"\" Perform http request using yewtube user agent header.\n\n if report is True, return whether response is from memo\n\n \"\"\"\n # create url opener\n ua = \"mps-youtube/%s ( %s )\" % (__version__, __url__)\n mpsyt_opener = build_opener()\n mpsyt_opener.addheaders = [('User-agent', ua)]\n\n # convert query to sorted list of tuples (needed for consistent url_memo)\n query = [(k, query[k]) for k in sorted(query.keys())]\n url = \"%s?%s\" % (url, urlencode(query))\n\n try:\n wdata = mpsyt_opener.open(url).read().decode()\n\n except (URLError, HTTPError) as e:\n g.message = \"%s: %s (%s)\" % (err, e, url)\n g.content = content_py.logo(c.r)\n return None if not report else (None, False)\n\n return wdata if not report else (wdata, False)\n\n\ndef _best_song_match(songs, title, duration, titleweight, durationweight):\n \"\"\" Select best matching song based on title, length.\n\n Score from 0 to 1 where 1 is best. titleweight and durationweight\n parameters added to enable function usage when duration can't be guessed\n\n \"\"\"\n # pylint: disable=R0914\n seqmatch = difflib.SequenceMatcher\n\n def variance(a, b):\n \"\"\" Return difference ratio. \"\"\"\n return float(abs(a - b)) / max(a, b)\n\n candidates = []\n\n ignore = \"music video lyrics new lyrics video audio\".split()\n extra = \"official original vevo\".split()\n\n for song in songs:\n dur, tit = int(song.length), song.title\n util.dbg(\"Title: %s, Duration: %s\", tit, dur)\n\n for word in extra:\n if word in tit.lower() and word not in title.lower():\n pattern = re.compile(word, re.I)\n tit = pattern.sub(\"\", tit)\n\n for word in ignore:\n if word in tit.lower() and word not in title.lower():\n pattern = re.compile(word, re.I)\n tit = pattern.sub(\"\", tit)\n\n replacechars = re.compile(r\"[\\]\\[\\)\\(\\-]\")\n tit = replacechars.sub(\" \", tit)\n multiple_spaces = re.compile(r\"(\\s)(\\s*)\")\n tit = multiple_spaces.sub(r\"\\1\", tit)\n\n title_score = seqmatch(None, title.lower(), tit.lower()).ratio()\n duration_score = 1 - variance(duration, dur)\n util.dbg(\"Title score: %s, Duration score: %s\", title_score,\n duration_score)\n\n # apply weightings\n score = duration_score * durationweight + title_score * titleweight\n candidates.append((score, song))\n\n best_score, best_song = max(candidates, key=lambda x: x[0])\n percent_score = int(100 * best_score)\n return best_song, percent_score\n\n\ndef _match_tracks(artist, title, mb_tracks):\n \"\"\" Match list of tracks in mb_tracks by performing multiple searches. \"\"\"\n # pylint: disable=R0914\n util.dbg(\"artists is %s\", artist)\n util.dbg(\"title is %s\", title)\n title_artist_str = c.g + title + c.w, c.g + artist + c.w\n util.xprint(\"\\nSearching for %s by %s\\n\\n\" % title_artist_str)\n\n def dtime(x):\n \"\"\" Format time to M:S. \"\"\"\n return time.strftime('%M:%S', time.gmtime(int(x)))\n\n # do matching\n for track in mb_tracks:\n ttitle = track['title']\n length = track['length']\n util.xprint(\"Search : %s%s - %s%s - %s\" % (c.y, artist, ttitle, c.w,\n dtime(length)))\n q = \"%s %s\" % (artist, ttitle)\n w = q = ttitle if artist == \"Various Artists\" else q\n query = w#generate_search_qs(w, 0)\n util.dbg(query)\n\n # perform fetch\n wdata = pafy.search_videos(q, int(config.PAGES.get)) # pafy.call_gdata('search', query)\n results = get_tracks_from_json(wdata)\n\n if not results:\n util.xprint(c.r + \"Nothing matched :(\\n\" + c.w)\n continue\n\n s, score = _best_song_match(\n results, artist + \" \" + ttitle, length, .5, .5)\n cc = c.g if score > 85 else c.y\n cc = c.r if score < 75 else cc\n util.xprint(\"Matched: %s%s%s - %s \\n[%sMatch confidence: \"\n \"%s%s]\\n\" % (c.y, s.title, c.w, util.fmt_time(s.length),\n cc, score, c.w))\n yield s\n\n\ndef _get_mb_tracks(albumid):\n \"\"\" Get track listing from MusicBraiz by album id. \"\"\"\n ns = {'mb': 'http://musicbrainz.org/ns/mmd-2.0#'}\n url = \"http://musicbrainz.org/ws/2/release/\" + albumid\n query = {\"inc\": \"recordings\"}\n wdata = _do_query(url, query, err='album search error')\n\n if not wdata:\n return None\n\n root = ET.fromstring(wdata)\n tlist = root.find(\"./mb:release/mb:medium-list/mb:medium/mb:track-list\",\n namespaces=ns)\n mb_songs = tlist.findall(\"mb:track\", namespaces=ns)\n tracks = []\n path = \"./mb:recording/mb:\"\n\n for track in mb_songs:\n\n try:\n title, length, rawlength = \"unknown\", 0, 0\n title = track.find(path + \"title\", namespaces=ns).text\n rawlength = track.find(path + \"length\", namespaces=ns).text\n length = int(round(float(rawlength) / 1000))\n\n except (ValueError, AttributeError):\n util.xprint(\"not found\")\n\n tracks.append(dict(title=title, length=length, rawlength=rawlength))\n\n return tracks\n\n\ndef _get_mb_album(albumname, **kwa):\n \"\"\" Return artist, album title and track count from MusicBrainz. \"\"\"\n url = \"http://musicbrainz.org/ws/2/release/\"\n qargs = dict(\n release='\"%s\"' % albumname,\n primarytype=kwa.get(\"primarytype\", \"album\"),\n status=kwa.get(\"status\", \"official\"))\n qargs.update({k: '\"%s\"' % v for k, v in kwa.items()})\n qargs = [\"%s:%s\" % item for item in qargs.items()]\n qargs = {\"query\": \" AND \".join(qargs)}\n g.message = \"Album search for '%s%s%s'\" % (c.y, albumname, c.w)\n wdata = _do_query(url, qargs)\n\n if not wdata:\n return None\n\n ns = {'mb': 'http://musicbrainz.org/ns/mmd-2.0#'}\n root = ET.fromstring(wdata)\n rlist = root.find(\"mb:release-list\", namespaces=ns)\n\n if int(rlist.get('count')) == 0:\n return None\n\n album = rlist.find(\"mb:release\", namespaces=ns)\n artist = album.find(\"./mb:artist-credit/mb:name-credit/mb:artist\",\n namespaces=ns).find(\"mb:name\", namespaces=ns).text\n title = album.find(\"mb:title\", namespaces=ns).text\n aid = album.get('id')\n return dict(artist=artist, title=title, aid=aid)\n\n\n@command(r'album\\s*(.{0,500})', 'album')\ndef search_album(term):\n \"\"\"Search for albums. \"\"\"\n # pylint: disable=R0914,R0912\n if not term:\n show_message(\"Enter album name:\", c.g, update=True)\n term = input(\"> \")\n\n if not term or len(term) < 2:\n g.message = c.r + \"Not enough input!\" + c.w\n g.content = content_py.generate_songlist_display()\n return\n\n album = _get_mb_album(term)\n\n if not album:\n show_message(\"Album '%s' not found!\" % term)\n return\n\n prompt = \"Artist? [%s] > \" % album['artist']\n util.xprint(prompt, end=\"\")\n artistentry = input().strip()\n\n if artistentry:\n\n if artistentry == \"q\":\n show_message(\"Album search abandoned!\")\n return\n\n album = _get_mb_album(term, artist=artistentry)\n\n if not album:\n show_message(\"Album '%s' by '%s' not found!\" % (term, artistentry))\n return\n\n title, artist = album['title'], album['artist']\n mb_tracks = _get_mb_tracks(album['aid'])\n\n if not mb_tracks:\n show_message(\"Album '%s' by '%s' has 0 tracks!\" % (title, artist))\n return\n\n msg = \"%s%s%s by %s%s%s\\n\\n\" % (c.g, title, c.w, c.g, artist, c.w)\n msg += \"Enter to begin matching or [q] to abort\"\n g.message = msg\n g.content = \"Tracks:\\n\"\n for n, track in enumerate(mb_tracks, 1):\n g.content += \"%02s %s\" % (n, track['title'])\n g.content += \"\\n\"\n\n screen.update()\n entry = input(\"Continue? [Enter] > \")\n\n if entry == \"\":\n pass\n\n else:\n show_message(\"Album search abandoned!\")\n return\n\n songs = []\n screen.clear()\n itt = _match_tracks(artist, title, mb_tracks)\n\n stash = config.SEARCH_MUSIC.get, config.ORDER.get\n config.SEARCH_MUSIC.value = True\n config.ORDER.value = \"relevance\"\n\n try:\n songs.extend(itt)\n\n except KeyboardInterrupt:\n util.xprint(\"%sHalted!%s\" % (c.r, c.w))\n\n finally:\n config.SEARCH_MUSIC.value, config.ORDER.value = stash\n\n if songs:\n util.xprint(\"\\n%s / %s songs matched\" % (len(songs), len(mb_tracks)))\n input(\"Press Enter to continue\")\n if g.lastfm_network:\n g.artist = artist\n g.album = title\n g.scrobble = True\n # Fill up queue with all the track names\n g.scrobble_queue = [t['title'] for t in mb_tracks]\n\n msg = \"Contents of album %s%s - %s%s %s(%d/%d)%s:\" % (\n c.y, artist, title, c.w, c.b, len(songs), len(mb_tracks), c.w)\n failmsg = \"Found no album tracks for %s%s%s\" % (c.y, title, c.w)\n\n paginatesongs(songs, msg=msg, failmsg=failmsg)\n"
},
{
"path": "mps_youtube/commands/config.py",
"content": "from .. import g, c, config, util\nfrom . import command\n\n\n@command(r'set|showconfig', 'set', 'showconfig')\ndef showconfig():\n \"\"\" Dump config data. \"\"\"\n width = util.getxy().width\n longest_key = 17\n longest_val = 0\n has_temps = False\n\n for setting in config:\n val = config[setting]\n longest_val = max(longest_val, len(str(val.display)))\n has_temps = has_temps or val.temp_value is not None\n\n width -= 27\n s = \" %s%-{0}s%s : %-{1}s\".format(longest_key, longest_val+1)\n\n if has_temps:\n width -= longest_val + 5\n out = \" %s%-{}s %-{}s %s%s%s\\n\".format(longest_key, longest_val) % (\n c.ul, \"Key\", \"Value\", \"Temporary\", \" \" * width, c.w)\n else:\n out = \" %s%-{}s %s%s%s\\n\".format(longest_key) % (c.ul, \"Key\", \"Value\", \" \" * width, c.w)\n\n for setting in config:\n val = config[setting]\n\n # don't show player specific settings if unknown player\n if not util.is_known_player(config.PLAYER.get) and \\\n val.require_known_player:\n continue\n\n # don't show max_results if auto determined\n if g.detectable_size and setting == \"MAX_RESULTS\":\n continue\n\n if g.detectable_size and setting == \"CONSOLE_WIDTH\":\n continue\n\n out += s % (c.g, setting.lower(), c.w, val.display)\n\n if has_temps:\n out += \"%s%s\" % (c.w, val.display_temp)\n\n out += \"\\n\"\n\n g.content = out\n g.message = \"Enter %sset %s to change\\n\" % (c.g, c.w)\n g.message += \"Enter %sset all default%s to reset all\" % (c.g, c.w)\n\n\n@command(r'set\\s+-t\\s*([-\\w]+)\\s*(.*)')\ndef setconfigtemp(key, val):\n setconfig(key, val, is_temp=True)\n\n\n@command(r'set\\s+([-\\w]+)\\s*(.*)')\ndef setconfig(key, val, is_temp=False):\n \"\"\" Set configuration variable. \"\"\"\n key = key.replace(\"-\", \"_\")\n if key.upper() == \"ALL\" and val.upper() == \"DEFAULT\":\n\n for ci in config:\n config[ci].value = config[ci].default\n\n config.save()\n message = \"Default configuration reinstated\"\n\n elif not key.upper() in config:\n message = \"Unknown config item: %s%s%s\" % (c.r, key, c.w)\n\n elif val.upper() == \"DEFAULT\":\n att = config[key.upper()]\n att.value = att.default\n att.temp_value = None\n message = \"%s%s%s set to %s%s%s (default)\"\n dispval = att.display or \"None\"\n message = message % (c.y, key, c.w, c.y, dispval, c.w)\n config.save()\n\n else:\n # config.save() will be called by config.set() method\n message = config[key.upper()].set(val, is_temp=is_temp)\n\n showconfig()\n g.message = message\n\n\n@command(r'encoders?', 'encoder')\ndef show_encs():\n \"\"\" Display available encoding presets. \"\"\"\n out = \"%sEncoding profiles:%s\\n\\n\" % (c.ul, c.w)\n\n for x, e in enumerate(g.encoders):\n sel = \" (%sselected%s)\" % (c.y, c.w) if config.ENCODER.get == x else \"\"\n out += \"%2d. %s%s\\n\" % (x, e['name'], sel)\n\n g.content = out\n message = \"Enter %sset encoder %s to select an encoder\"\n g.message = message % (c.g, c.w)\n"
},
{
"path": "mps_youtube/commands/download.py",
"content": "import os\nimport re\nimport sys\nimport time\nimport shlex\nimport random\nimport subprocess\nfrom urllib.request import urlopen\nfrom urllib.error import HTTPError\n\nfrom .. import g, c, screen, streams, content, config, util, pafy\nfrom . import command, PL\nfrom .search import yt_url, user_pls\nfrom .songlist import dump, plist\n\n\n@command(r'(dv|da|d|dl|download)\\s*(\\d{1,4})', 'da', 'dv', 'd', 'dl', 'download')\ndef download(dltype, num):\n \"\"\" Download a track or playlist by menu item number. \"\"\"\n # This function needs refactoring!\n # pylint: disable=R0912\n # pylint: disable=R0914\n if g.browse_mode == \"ytpl\" and dltype in (\"da\", \"dv\"):\n plid = g.ytpls[int(num) - 1][\"link\"]\n down_plist(dltype, plid)\n return\n\n elif g.browse_mode == \"ytpl\":\n g.message = \"Use da or dv to specify audio / video playlist download\"\n g.message = c.y + g.message + c.w\n g.content = content.generate_songlist_display()\n return\n\n elif g.browse_mode != \"normal\":\n g.message = \"Download must refer to a specific video item\"\n g.message = c.y + g.message + c.w\n g.content = content.generate_songlist_display()\n return\n\n screen.writestatus(\"Fetching video info...\")\n song = (g.model[int(num) - 1])\n\n # best = dltype.startswith(\"dv\") or dltype.startswith(\"da\")\n #\n # if not best:\n #\n # try:\n # # user prompt for download stream\n # url, ext, url_au, ext_au = prompt_dl(song)\n #\n # except KeyboardInterrupt:\n # g.message = c.r + \"Download aborted!\" + c.w\n # g.content = content.generate_songlist_display()\n # return\n #\n # if not url or ext_au == \"abort\":\n # # abort on invalid stream selection\n # g.content = content.generate_songlist_display()\n # g.message = \"%sNo download selected / invalid input%s\" % (c.y, c.w)\n # return\n #\n # else:\n # # download user selected stream(s)\n # filename = _make_fname(song, ext)\n # args = (song, filename, url)\n #\n # if url_au and ext_au:\n # # downloading video and audio stream for muxing\n # audio = False\n # filename_au = _make_fname(song, ext_au)\n # args_au = (song, filename_au, url_au)\n #\n # else:\n # audio = ext in (\"m4a\", \"ogg\")\n #\n # kwargs = dict(audio=audio)\n #\n # elif best:\n # # set updownload without prompt\n # url_au = None\n # av = \"audio\" if dltype.startswith(\"da\") else \"video\"\n # audio = av == \"audio\"\n # filename = _make_fname(song, None, av=av)\n # args = (song, filename)\n # kwargs = dict(url=None, audio=audio)\n\n try:\n # perform download(s)\n # dl_filenames = [args[1]]\n # f = _download(*args, **kwargs)\n success = pafy.download_video(song.ytid, config.DDIR.get, True if dltype.startswith(\"da\") else False)\n if success:\n g.message = \"Saved \\'\" + song.title + \"\\' to \" + c.g + config.DDIR.get + c.w\n\n # if url_au:\n # dl_filenames += [args_au[1]]\n # _download(*args_au, allow_transcode=False, **kwargs)\n\n except KeyboardInterrupt:\n g.message = c.r + \"Download halted!\" + c.w\n\n # try:\n # for downloaded in dl_filenames:\n # os.remove(downloaded)\n #\n # except IOError:\n # pass\n\n # if url_au:\n # # multiplex\n # name, ext = os.path.splitext(args[1])\n # tmpvideoname = name + '.' +str(random.randint(10000, 99999)) + ext\n # os.rename(args[1], tmpvideoname)\n # mux_cmd = [g.muxapp, \"-i\", tmpvideoname, \"-i\", args_au[1], \"-c\",\n # \"copy\", name + \".mp4\"]\n #\n # try:\n # subprocess.call(mux_cmd)\n # g.message = \"Saved to :\" + c.g + mux_cmd[7] + c.w\n # os.remove(tmpvideoname)\n # os.remove(args_au[1])\n #\n # except KeyboardInterrupt:\n # g.message = \"Audio/Video multiplex aborted!\"\n\n g.content = content.generate_songlist_display()\n\n\n@command(r'(da|dv)\\s+((?:\\d+\\s\\d+|-\\d+|\\d+-|\\d+,)(?:[\\d\\s,-]*))', 'da', 'dv')\ndef down_many(dltype, choice, subdir=None):\n \"\"\" Download multiple items. \"\"\"\n choice = util.parse_multi(choice)\n choice = list(set(choice))\n downsongs = [g.model[int(x) - 1] for x in choice]\n temp = g.model[::]\n g.model.songs = downsongs[::]\n count = len(downsongs)\n av = \"audio\" if dltype.startswith(\"da\") else \"video\"\n msg = \"\"\n\n def handle_error(message):\n \"\"\" Handle error in download. \"\"\"\n g.message = message\n g.content = disp\n screen.update()\n time.sleep(2)\n g.model.songs.pop(0)\n\n try:\n for song in downsongs:\n g.result_count = len(g.model)\n disp = content.generate_songlist_display()\n title = \"Download Queue (%s):%s\\n\\n\" % (av, c.w)\n disp = re.sub(r\"(Num\\s*?Title.*?\\n)\", title, disp)\n g.content = disp\n screen.update()\n\n try:\n filename = _make_fname(song, None, av=av, subdir=subdir)\n\n except IOError as e:\n handle_error(\"Error for %s: %s\" % (song.title, str(e)))\n count -= 1\n continue\n\n except KeyError:\n handle_error(\"No audio track for %s\" % song.title)\n count -= 1\n continue\n\n try:\n _download(song, filename, url=None, audio=av == \"audio\")\n\n except HTTPError:\n handle_error(\"HTTP Error for %s\" % song.title)\n count -= 1\n continue\n\n g.model.songs.pop(0)\n msg = \"Downloaded %s items\" % count\n g.message = \"Saved to \" + c.g + song.title + c.w\n\n except KeyboardInterrupt:\n msg = \"Downloads interrupted!\"\n\n finally:\n g.model.songs = temp[::]\n g.message = msg\n g.result_count = len(g.model)\n g.content = content.generate_songlist_display()\n\n\n@command(r'(da|dv)pl\\s+%s' % PL, 'dapl', 'dvpl')\ndef down_plist(dltype, parturl):\n \"\"\" Download YouTube playlist. \"\"\"\n\n plist(parturl)\n dump(False)\n title = g.pafy_pls[parturl][0].title\n # Remove double quotes for convenience\n subdir = util.sanitize_filename(title.replace('\"', ''))\n down_many(dltype, \"1-\", subdir=subdir)\n msg = g.message\n plist(parturl)\n g.message = msg\n\n\n@command(r'(da|dv)upl\\s+(.*)', 'daupl', 'dvupl')\ndef down_user_pls(dltype, user):\n \"\"\" Download all user playlists. \"\"\"\n user_pls(user)\n for i in g.ytpls:\n down_plist(dltype, i.get('link'))\n\n return\n\n\ndef _make_fname(song, ext=None, av=None, subdir=None):\n \"\"\"\" Create download directory, generate filename. \"\"\"\n # pylint: disable=E1103\n # Instance of 'bool' has no 'extension' member (some types not inferable)\n ddir = os.path.join(config.DDIR.get, subdir) if subdir else config.DDIR.get\n if not os.path.exists(ddir):\n os.makedirs(ddir)\n\n if not ext:\n stream = streams.select(streams.get(song),\n audio=av == \"audio\", m4a_ok=True)\n ext = stream['ext']\n\n # filename = song.title[:59] + \".\" + ext\n filename = song.title + \".\" + ext\n # Remove double quotes for convenience\n filename = filename.replace('\"', '')\n filename = os.path.join(ddir, util.sanitize_filename(filename))\n return filename\n\n\ndef extract_metadata(name):\n \"\"\" Try to determine metadata from video title. \"\"\"\n seps = name.count(\" - \")\n artist = title = None\n\n if seps == 1:\n\n pos = name.find(\" - \")\n artist = name[:pos].strip()\n title = name[pos + 3:].strip()\n\n else:\n title = name.strip()\n\n return dict(artist=artist, title=title)\n\n\ndef remux_audio(filename, title):\n \"\"\" Remux audio file. Insert limited metadata tags. \"\"\"\n util.dbg(\"starting remux\")\n temp_file = filename + \".\" + str(random.randint(10000, 99999))\n os.rename(filename, temp_file)\n meta = extract_metadata(title)\n metadata = [\"title=%s\" % meta[\"title\"]]\n\n if meta[\"artist\"]:\n metadata = [\"title=%s\" % meta[\"title\"], \"-metadata\",\n \"artist=%s\" % meta[\"artist\"]]\n\n cmd = [g.muxapp, \"-y\", \"-i\", temp_file, \"-acodec\", \"copy\", \"-metadata\"]\n cmd += metadata + [\"-vn\", filename]\n util.dbg(cmd)\n\n try:\n with open(os.devnull, \"w\") as devnull:\n subprocess.call(cmd, stdout=devnull, stderr=subprocess.STDOUT)\n\n except OSError:\n util.dbg(\"Failed to remux audio using %s\", g.muxapp)\n os.rename(temp_file, filename)\n\n else:\n os.unlink(temp_file)\n util.dbg(\"remuxed audio file using %s\" % g.muxapp)\n\n\ndef transcode(filename, enc_data):\n \"\"\" Re encode a download. \"\"\"\n base = os.path.splitext(filename)[0]\n exe = g.muxapp if g.transcoder_path == \"auto\" else g.transcoder_path\n\n # ensure valid executable\n if not exe or not os.path.exists(exe) or not os.access(exe, os.X_OK):\n util.xprint(\"Encoding failed. Couldn't find a valid encoder :(\\n\")\n time.sleep(2)\n return filename\n\n command = shlex.split(enc_data['command'])\n newcom, outfn = command[::], \"\"\n\n for n, d in enumerate(command):\n\n if d == \"ENCODER_PATH\":\n newcom[n] = exe\n\n elif d == \"IN\":\n newcom[n] = filename\n\n elif d == \"OUT\":\n newcom[n] = outfn = base\n\n elif d == \"OUT.EXT\":\n newcom[n] = outfn = base + \".\" + enc_data['ext']\n\n returncode = subprocess.call(newcom)\n\n if returncode == 0 and g.delete_orig:\n os.unlink(filename)\n\n return outfn\n\n\ndef external_download(song, filename, url):\n \"\"\" Perform download using external application. \"\"\"\n cmd = config.DOWNLOAD_COMMAND.get\n ddir, basename = config.DDIR.get, os.path.basename(filename)\n cmd_list = shlex.split(cmd)\n\n def list_string_sub(orig, repl, lst):\n \"\"\" Replace substrings for items in a list. \"\"\"\n return [x if orig not in x else x.replace(orig, repl) for x in lst]\n\n cmd_list = list_string_sub(\"%F\", filename, cmd_list)\n cmd_list = list_string_sub(\"%d\", ddir, cmd_list)\n cmd_list = list_string_sub(\"%f\", basename, cmd_list)\n cmd_list = list_string_sub(\"%u\", url, cmd_list)\n cmd_list = list_string_sub(\"%i\", song.ytid, cmd_list)\n util.dbg(\"Downloading using: %s\", \" \".join(cmd_list))\n subprocess.call(cmd_list)\n\n\ndef _download(song, filename, url=None, audio=False, allow_transcode=True):\n \"\"\" Download file, show status.\n\n Return filename or None in case of user specified download command.\n\n \"\"\"\n # pylint: disable=R0914\n # too many local variables\n # Instance of 'bool' has no 'url' member (some types not inferable)\n\n if not url:\n stream = streams.select(streams.get(song), audio=audio, m4a_ok=True)\n url = stream['url']\n\n # if an external download command is set, use it\n if config.DOWNLOAD_COMMAND.get:\n title = c.y + os.path.splitext(os.path.basename(filename))[0] + c.w\n util.xprint(\"Downloading %s using custom command\" % title)\n external_download(song, filename, url)\n return None\n\n if not config.OVERWRITE.get:\n if os.path.exists(filename):\n util.xprint(\"File exists. Skipping %s%s%s ..\\n\" %\n (c.r, filename, c.w))\n time.sleep(0.2)\n return filename\n\n util.xprint(\"Downloading to %s%s%s ..\" % (c.r, filename, c.w))\n status_string = (' {0}{1:,}{2} Bytes [{0}{3:.2%}{2}] received. Rate: '\n '[{0}{4:4.0f} kbps{2}]. ETA: [{0}{5:.0f} secs{2}]')\n\n resp = urlopen(url)\n total = int(resp.info()['Content-Length'].strip())\n chunksize, bytesdone, t0 = 16384, 0, time.time()\n outfh = open(filename, 'wb')\n\n while True:\n chunk = resp.read(chunksize)\n outfh.write(chunk)\n elapsed = time.time() - t0\n bytesdone += len(chunk)\n rate = 0\n if elapsed != 0:\n rate = (bytesdone / 1024) / elapsed\n if rate:\n eta = (total - bytesdone) / (rate * 1024)\n else:\n eta = 0\n stats = (c.y, bytesdone, c.w, bytesdone * 1.0 / total, rate, eta)\n\n if not chunk:\n outfh.close()\n break\n\n status = status_string.format(*stats)\n sys.stdout.write(\"\\r\" + status + ' ' * 4 + \"\\r\")\n sys.stdout.flush()\n\n active_encoder = g.encoders[config.ENCODER.get]\n ext = filename.split(\".\")[-1]\n valid_ext = ext in active_encoder['valid'].split(\",\")\n\n if audio and g.muxapp:\n remux_audio(filename, song.title)\n\n if config.ENCODER.get != 0 and valid_ext and allow_transcode:\n filename = transcode(filename, active_encoder)\n\n return filename\n\n\ndef menu_prompt(model, prompt=\" > \", rows=None, header=None, theading=None,\n footer=None, force=0):\n \"\"\" Generate a list of choice, returns item from model. \"\"\"\n content = \"\"\n\n for x in header, theading, rows, footer:\n if isinstance(x, list):\n\n for line in x:\n content += line + \"\\n\"\n\n elif isinstance(x, str):\n content += x + \"\\n\"\n\n g.content = content\n screen.update()\n\n choice = input(prompt)\n\n if choice in model:\n return model[choice]\n\n elif force:\n return menu_prompt(model, prompt, rows, header, theading, footer,\n force)\n\n elif not choice.strip():\n return False, False\n\n else: # unrecognised input\n return False, \"abort\"\n\n\ndef prompt_dl(song):\n \"\"\" Prompt user do choose a stream to dl. Return (url, extension). \"\"\"\n # pylint: disable=R0914\n dl_data, p = get_dl_data(song)\n dl_text = gen_dl_text(dl_data, song, p)\n\n model = [x['url'] for x in dl_data]\n ed = enumerate(dl_data)\n model = {str(n + 1): (x['url'], x['ext']) for n, x in ed}\n url, ext = menu_prompt(model, \"Download number: \", *dl_text)\n url2 = ext2 = None\n mediatype = [i for i in dl_data if i['url'] == url][0]['mediatype']\n\n if mediatype == \"video\" and g.muxapp and not config.DOWNLOAD_COMMAND.get:\n # offer mux if not using external downloader\n dl_data, p = get_dl_data(song, mediatype=\"audio\")\n dl_text = gen_dl_text(dl_data, song, p)\n au_choices = \"1\" if len(dl_data) == 1 else \"1-%s\" % len(dl_data)\n footer = [util.F('-audio') % ext, util.F('select mux') % au_choices]\n dl_text = tuple(dl_text[0:3]) + (footer,)\n aext = (\"ogg\", \"m4a\")\n model = [x['url'] for x in dl_data if x['ext'] in aext]\n ed = enumerate(dl_data)\n model = {str(n + 1): (x['url'], x['ext']) for n, x in ed}\n prompt = \"Audio stream: \"\n url2, ext2 = menu_prompt(model, prompt, *dl_text)\n\n return url, ext, url2, ext2\n\n\ndef gen_dl_text(ddata, song, p):\n \"\"\" Generate text for dl screen. \"\"\"\n hdr = []\n hdr.append(\" %s%s%s\" % (c.r, song.title, c.w))\n author = p.author\n hdr.append(c.r + \" Uploaded by \" + author + c.w)\n hdr.append(\" [\" + util.fmt_time(song.length) + \"]\")\n hdr.append(\"\")\n\n heading = tuple(\"Item Format Quality Media Size Notes\".split())\n fmt = \" {0}%-6s %-8s %-13s %-7s %-5s %-16s{1}\"\n heading = [fmt.format(c.w, c.w) % heading]\n heading.append(\"\")\n\n content = []\n\n for n, d in enumerate(ddata):\n row = (n + 1, d['ext'], d['quality'], d['mediatype'], d['size'],\n d['notes'])\n fmt = \" {0}%-6s %-8s %-13s %-7s %5s Mb %-16s{1}\"\n row = fmt.format(c.g, c.w) % row\n content.append(row)\n\n content.append(\"\")\n\n footer = \"Select [%s1-%s%s] to download or [%sEnter%s] to return\"\n footer = [footer % (c.y, len(content) - 1, c.w, c.y, c.w)]\n return(content, hdr, heading, footer)\n\n\ndef get_dl_data(song, mediatype=\"any\"):\n \"\"\" Get filesize and metadata for all streams, return dict. \"\"\"\n def mbsize(x):\n \"\"\" Return size in MB. \"\"\"\n return str(int(x / (1024 ** 2)))\n\n p = util.get_pafy(song)\n dldata = []\n text = \" [Fetching stream info] >\"\n streamlist = [x for x in p.allstreams]\n\n if mediatype == \"audio\":\n streamlist = [x for x in p.audiostreams]\n\n l = len(streamlist)\n for n, stream in enumerate(streamlist):\n sys.stdout.write(text + \"-\" * n + \">\" + \" \" * (l - n - 1) + \"<\\r\")\n sys.stdout.flush()\n\n try:\n size = mbsize(stream.get_filesize())\n\n except TypeError:\n util.dbg(c.r + \"---Error getting stream size\" + c.w)\n size = 0\n\n item = {'mediatype': stream.mediatype,\n 'size': size,\n 'ext': stream.extension,\n 'quality': stream.quality,\n 'notes': stream.notes,\n 'url': stream.url}\n\n dldata.append(item)\n\n screen.writestatus(\"\")\n return dldata, p\n\n\n@command(r'dlurl\\s(.*[-_a-zA-Z0-9]{11}.*)', 'dlurl')\ndef dl_url(url):\n \"\"\" Open and prompt for download of youtube video url. \"\"\"\n g.browse_mode = \"normal\"\n yt_url(url)\n\n if len(g.model) == 1:\n download(\"download\", \"1\")\n\n if g.command_line:\n sys.exit()\n\n\n@command(r'daurl\\s(.*[-_a-zA-Z0-9]{11}.*)', 'daurl')\ndef da_url(url):\n \"\"\" Open and prompt for download of youtube best audio from url. \"\"\"\n g.browse_mode = \"normal\"\n yt_url(url)\n\n if len(g.model) == 1:\n download(\"da\", \"1\")\n\n if g.command_line:\n sys.exit()\n"
},
{
"path": "mps_youtube/commands/generate_playlist.py",
"content": "\"\"\"\n Playlist Generation\n\"\"\"\nfrom os import path\nfrom random import choice\nimport string\n\nfrom .. import content, g, playlists, screen, util, listview\nfrom ..playlist import Playlist\nfrom . import command, search, album_search\n\n\n@command(r'mkp\\s*(.{1,100})', 'mkp')\ndef generate_playlist(sourcefile):\n \"\"\"Generate a playlist from video titles in sourcefile\"\"\"\n\n # Hooks into this, check if the argument --description is present\n if \"--description\" in sourcefile or \"-d\" in sourcefile:\n description_generator(sourcefile)\n return\n\n expanded_sourcefile = path.expanduser(sourcefile)\n if not check_sourcefile(expanded_sourcefile):\n g.message = util.F('mkp empty') % expanded_sourcefile\n else:\n queries = read_sourcefile(expanded_sourcefile)\n g.message = util.F('mkp parsed') % (len(queries), sourcefile)\n if queries:\n create_playlist(queries)\n g.message = util.F('pl help')\n g.content = content.playlists_display()\n\n\ndef read_sourcefile(filename):\n \"\"\"Read each line as a query from filename\"\"\"\n with open(filename) as srcfl:\n queries = list()\n for item in srcfl.readlines():\n clean_item = str(item).strip()\n if not clean_item:\n continue\n queries.append(clean_item)\n return queries\n\n\ndef check_sourcefile(filename):\n \"\"\"Check if filename exists and has a non-zero size\"\"\"\n return path.isfile(filename) and path.getsize(filename) > 0\n\n\ndef create_playlist(queries, title=''):\n \"\"\"Add a new playlist\n\n Create playlist with a random name, get the first\n match for each title in queries and append it to the playlist\n \"\"\"\n plname = title.replace(\" \", \"-\") or random_plname()\n if not g.userpl.get(plname):\n g.userpl[plname] = Playlist(plname)\n for query in queries:\n g.message = util.F('mkp finding') % query\n screen.update()\n qresult = find_best_match(query)\n if qresult:\n g.userpl[plname].songs.append(qresult)\n if g.userpl[plname]:\n playlists.save()\n\n\ndef find_best_match(query):\n \"\"\"Find the best(first)\"\"\"\n # This assumes that the first match is the best one\n qs = search.generate_search_qs(query)\n wdata = pafy.call_gdata('search', qs)\n results = search.get_tracks_from_json(wdata)\n if results:\n res, score = album_search._best_song_match(\n results, query, 0.1, 1.0, 0.0)\n return res\n\n\ndef random_plname():\n \"\"\"Generates a random alphanumeric string of 6 characters\"\"\"\n n_chars = 6\n return ''.join(choice(string.ascii_lowercase + string.digits)\n for _ in range(n_chars))\n\n\ndef description_generator(text):\n \"\"\" Fetches a videos description and parses it for\n -