yewtube


Nameyewtube JSON
Version 2.10.4 PyPI version JSON
download
home_pagehttps://github.com/iamtalhaasghar/yewtube
SummaryA Terminal based YouTube player and downloader. No Youtube API key required. Forked from mps-youtube
upload_time2023-06-14 12:17:36
maintainer
docs_urlNone
authortalha_programmer
requires_python>=3.6
license
keywords video music audio youtube stream download
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
![](https://img.shields.io/pypi/v/yewtube.svg)  ![](https://img.shields.io/pypi/wheel/yewtube.svg)

<pre>
                      _         _          
                     | |       | |         
  _   _  _____      _| |_ _   _| |__   ___ 
 | | | |/ _ \ \ /\ / / __| | | | '_ \ / _ \
 | |_| |  __/\ V  V /| |_| |_| | |_) |  __/
  \__, |\___| \_/\_/  \__|\__,_|_.__/ \___|
   __/ |                                   
  |___/


</pre>

yewtube, forked from mps-youtube , is a Terminal based YouTube player and downloader. No Youtube API key required. <br>
Visit [this](./COLLABORATORS.md) page if you want to support maintainers of this project.

Installation
-----------
# Stable Version

### Using pip
1. Install using `pip install yewtube`
2. Run using, `yt`. Enjoy! 

### Using pipx (Recommended)
1.  Install **_pipx_** using `pip install pipx`
2.  Install `yewtube` using `pipx install yewtube`
3.  Now, type `yt` That's it.

# Latest Version

### Using pip
1. Install using `pip install git+https://github.com/iamtalhaasghar/yewtube.git`
2. Run using, `yt`. Enjoy! 

### Using pipx
1.  Install **_pipx_** using `pip install pipx`
2.  Install `yewtube` using `pipx install git+https://github.com/iamtalhaasghar/yewtube.git`
3.  Now, type `yt` That's it.

What's new in yewtube?
----------------------
-   **No Youtube API Key required**
-   **Run audio in VLC with no GUI**

See complete and up-to-date changelog [here](https://github.com/iamtalhaasghar/yewtube/blob/master/CHANGELOG.md).

These features are still inherited from [mps-youtube](https://github.com/mps-youtube/mps-youtube).
-   Search and play audio/video from YouTube
-   Search tracks of albums by album title
-   Search and import YouTube playlists
-   Create and save local playlists
-   Download audio/video
-   Convert to mp3 & other formats (requires ffmpeg or avconv)
-   View video comments
-   Works with Python 3.x
-   Works with Windows, Linux and Mac OS X
-   Requires mplayer, mpv or VLC

This 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
implementation uses YouTube as a source of content and can play and
download video as well as audio. The [pafy](https://github.com/mps-youtube/pafy)  library handles interfacing with YouTube.

[mps-youtube wiki](https://github.com/mps-youtube/mps-youtube/wiki/Troubleshooting) <br>
[yewtube wiki](https://github.com/iamtalhaasghar/yewtube/wiki/FAQ)

Screenshots
-----------

Search:<br>
![](http://mps-youtube.github.io/yewtube/std-search.png)

A standard search is performed by entering `/` followed by search terms.

You can play all of the search results by giving `1-` as input

Repeating song/songs can be done with `song_number[loop]`, for example:
`1[3]` or `4-6[2]`

Local Playlists:<br>
![](http://mps-youtube.github.io/yewtube/local-playlist.png)

Search result items can easily be stored in local playlists.

YouTube Playlists:<br>
![](http://mps-youtube.github.io/yewtube/playlist-search.png)

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

A playlist search is performed by `//` followed by search term.

Download:<br>
![](http://mps-youtube.github.io/yewtube/download.png)

Content can be downloaded in various formats and resolutions.

Comments:<br>
![](http://mps-youtube.github.io/yewtube/comments.png)

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

Music Album Matching:<br>

![](http://mps-youtube.github.io/yewtube/album-1.png)

![](http://mps-youtube.github.io/yewtube/album-2.png)

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

Customisation:<br>

![](http://mps-youtube.github.io/yewtube/customisation2.png)

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

This configuration was set up using the following commands
```
set order views
set columns user:14 date comments rating likes dislikes category:9 views
```

Type `help config` for help on configuration options

Upgrading
---------

### If installed using pipx

` pipx upgrade yewtube `

### If installed using pip

`pip install --upgrade yewtube`

Usage
-----

yewtube is run on the command line using the command:

   `yt`

Enter `h` from within the program for help.


Using yewtube with mpris
------------------------

1. Install PyGObject, GTK and their dependencies based on this guide https://pygobject.readthedocs.io/en/latest/getting_started.html
2. Install yewtube with mpris extra

```shell
> # recommended
> pipx install 'yewtube[mpris]'
> # or
> pip install 'yewtube[mpris]'
```

3. check yewtube version

```shell
> yt --version
yewtube version    : 2.8.2
yt_dlp version     : 2022.02.04
Python version     : 3.9.7 (default, Nov  7 2021, 15:17:57)
[GCC 11.2.0]
Processor          : x86_64
Machine type       : x86_64
Architecture       : 64bit, ELF
Platform           : Linux-5.13.0-35-generic-x86_64-with-glibc2.34
sys.stdout.enc     : utf-8
default enc        : utf-8
Config dir         : /home/user/.config/mps-youtube
dbus               : 1.2.18
glib               : True
env:TERM           : tmux-256color
env:SHELL          : /usr/bin/zsh
env:LANG           : en_US.UTF-8
```

If everything working correctly, dbug and glib would have similar result as above text

4. run `set mpris true` on yewtube
5. check with `playerctl`

```shell
> playerctl -l
mps-youtube.instance567867
```

Check also the [common-issue](https://github.com/iamtalhaasghar/yewtube/wiki/Common-issues) if you are having problem with yewtube.

How to Contribute
-----------------

Contributions are warmly welcomed! However, please check out the [contribution page](https://github.com/iamtalhaasghar/yewtube/blob/master/CONTRIBUTING.md) before making a contribution.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/iamtalhaasghar/yewtube",
    "name": "yewtube",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "video,music,audio,youtube,stream,download",
    "author": "talha_programmer",
    "author_email": "talhaasghar.contact@simplelogin.fr",
    "download_url": "https://files.pythonhosted.org/packages/8e/09/eb56c8b2e7482dfa73db1b15ca9c5a23100ea1004ed434d9f097787358d4/yewtube-2.10.4.tar.gz",
    "platform": null,
    "description": "\n![](https://img.shields.io/pypi/v/yewtube.svg)  ![](https://img.shields.io/pypi/wheel/yewtube.svg)\n\n<pre>\n                      _         _          \n                     | |       | |         \n  _   _  _____      _| |_ _   _| |__   ___ \n | | | |/ _ \\ \\ /\\ / / __| | | | '_ \\ / _ \\\n | |_| |  __/\\ V  V /| |_| |_| | |_) |  __/\n  \\__, |\\___| \\_/\\_/  \\__|\\__,_|_.__/ \\___|\n   __/ |                                   \n  |___/\n\n\n</pre>\n\nyewtube, forked from mps-youtube , is a Terminal based YouTube player and downloader. No Youtube API key required. <br>\nVisit [this](./COLLABORATORS.md) page if you want to support maintainers of this project.\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) <br>\n[yewtube wiki](https://github.com/iamtalhaasghar/yewtube/wiki/FAQ)\n\nScreenshots\n-----------\n\nSearch:<br>\n![](http://mps-youtube.github.io/yewtube/std-search.png)\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:<br>\n![](http://mps-youtube.github.io/yewtube/local-playlist.png)\n\nSearch result items can easily be stored in local playlists.\n\nYouTube Playlists:<br>\n![](http://mps-youtube.github.io/yewtube/playlist-search.png)\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:<br>\n![](http://mps-youtube.github.io/yewtube/download.png)\n\nContent can be downloaded in various formats and resolutions.\n\nComments:<br>\n![](http://mps-youtube.github.io/yewtube/comments.png)\n\nA basic comments browser is available to view YouTube user comments.\n\nMusic Album Matching:<br>\n\n![](http://mps-youtube.github.io/yewtube/album-1.png)\n\n![](http://mps-youtube.github.io/yewtube/album-2.png)\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:<br>\n\n![](http://mps-youtube.github.io/yewtube/customisation2.png)\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 warmly welcomed! However, please check out the [contribution page](https://github.com/iamtalhaasghar/yewtube/blob/master/CONTRIBUTING.md) before making a contribution.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A Terminal based YouTube player and downloader. No Youtube API key required. Forked from mps-youtube",
    "version": "2.10.4",
    "project_urls": {
        "Download": "https://github.com/iamtalhaasghar/yewtube/releases",
        "Homepage": "https://github.com/iamtalhaasghar/yewtube"
    },
    "split_keywords": [
        "video",
        "music",
        "audio",
        "youtube",
        "stream",
        "download"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5f9dd989219249a99afe269d28cdae6cfad5e2afc3450b5ba1a32e22f4fcfcb0",
                "md5": "e7efc7d74db4743c8b3cf317dba2f2e0",
                "sha256": "d6178504c653c3022f80f7ea9fa8b76f698600cbf6c71e4c5e5353eadc85f3a1"
            },
            "downloads": -1,
            "filename": "yewtube-2.10.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e7efc7d74db4743c8b3cf317dba2f2e0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 117837,
            "upload_time": "2023-06-14T12:17:34",
            "upload_time_iso_8601": "2023-06-14T12:17:34.766577Z",
            "url": "https://files.pythonhosted.org/packages/5f/9d/d989219249a99afe269d28cdae6cfad5e2afc3450b5ba1a32e22f4fcfcb0/yewtube-2.10.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8e09eb56c8b2e7482dfa73db1b15ca9c5a23100ea1004ed434d9f097787358d4",
                "md5": "6d31f9951e3710065832d1ed4841c897",
                "sha256": "0a3b9d355cb0e054209461aaa51591a01ffb9fe2b95d763b915def4101494963"
            },
            "downloads": -1,
            "filename": "yewtube-2.10.4.tar.gz",
            "has_sig": false,
            "md5_digest": "6d31f9951e3710065832d1ed4841c897",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 110709,
            "upload_time": "2023-06-14T12:17:36",
            "upload_time_iso_8601": "2023-06-14T12:17:36.263691Z",
            "url": "https://files.pythonhosted.org/packages/8e/09/eb56c8b2e7482dfa73db1b15ca9c5a23100ea1004ed434d9f097787358d4/yewtube-2.10.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-14 12:17:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "iamtalhaasghar",
    "github_project": "yewtube",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "yewtube"
}
        
Elapsed time: 0.08100s