pyutube


Namepyutube JSON
Version 1.4.13 PyPI version JSON
download
home_pageNone
SummaryAwesome CLI to download YouTube videos (as video or audio)/shorts/playlists from the terminal
upload_time2024-12-31 14:43:20
maintainerNone
docs_urlNone
authorEbraheem Alhetari
requires_python>=3.6
licenseMIT
keywords youtube download cli pyutube pytubefix pytube youtube-dl
VCS
bugtrack_url
requirements setuptools typer requests rich yaspin pytubefix inquirer termcolor moviepy
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 📹 Pyutube - The Simplest YouTube Downloader CLI

### Enjoying my project? Please show your appreciation by starring it on GitHub! ⭐
<a href="https://github.com/Hetari/pyutube">
  <img src="https://img.shields.io/pypi/v/pyutube.svg?style=flat&label=Version" alt="Version">
</a>
<a href="https://pepy.tech/projects/pyutube">
  <img src="https://static.pepy.tech/badge/pyutube" alt="Downloads">
</a>
<a href="https://pepy.tech/projects/pyutube">
  <img src="https://static.pepy.tech/badge/pyutube/month" alt="Downloads per Month">
</a>
<a href="https://pepy.tech/projects/pyutube">
  <img src="https://static.pepy.tech/badge/pyutube/week" alt="Downloads per Week">
</a>

<br />
<br />

> [!NOTE]
> `Pyutube` is built on top of `pytubefix`, make sure to have the latest version of `pytubefix` by running:
> ```bash
> pip install --upgrade pytubefix
> ```

<a href="https://ibb.co/27wcFYN">
   <img src="https://i.ibb.co/MDbPg56/Screenshot-from-2024-04-08-21-38-02-transformed.png" alt="Pyutube" style="width: 100%;">
</a>

> [!NOTE]
> Have **a new feature**? Please don't hesitate to [tell me](https://github.com/Hetari/pyutube/issues/new)!


## 🤔 why `pyutube`?

This command-line wizard lets you download YouTube videos or playlists straight from your `Terminal`, powered by [Pytubefix](https://pytubefix.readthedocs.io/). It works like a charm on Windows, Mac, and Linux, so you can rock it on any platform.

While other tools make you wade through a swamp of settings and configs, `Pyutube` keeps it simple. Just drop in your URL, and voilà! It’ll take you on a smooth ride to your favorite videos, no complex options needed—just fun downloading! 🔥

## 🛠️ Installation

Getting `Pyutube` up and running is a breeze! First, ensure you have [Python](https://www.python.org) installed. Just pop open your terminal and type:

```bash
python --version
```

If you see something like `Python 3.x`, you’re all set! If not, head over to [Python's downloads page](https://www.python.org/downloads/) to grab it.

Once you’re good to go, install `Pyutube` with a single command:

```bash
pip install pyutube
```

And just like that, you’re ready to download some awesome videos! 🎉

## 📈 Upgrade

Stay in the loop with the latest features on [GitHub](https://github.com/Hetari/pyutube)! To upgrade your `Pyutube` tool, simply run:

```bash
pip install --upgrade pyutube
```

Then you’re all set to keep downloading from your `Terminal`! 🥳


## 🦸 Quick Start

Getting started with `Pyutube` is a piece of cake! Just use the following command style:

```bash
pyutube "YOUTUBE_LINK" [PATH]
```

> [!NOTE]
> The `[URL]` is <span style="color:red">[Required]</span> and it should be between `""`<br/>
> The `[PATH]` is optional—if you don’t specify one, it’ll save to your current terminal directory. Easy-peasy!


## 👨‍💻 Usage

#### Arguments

| Arguments | Description                                                                                                          |
| --------- | -------------------------------------------------------------------------------------------------------------------- |
| `URL`     | The `URL` of the YouTube video. This argument is <span style="color:red">[Required]</span>.                          |
| `PATH`    | The `path` to save the video. Defaults to the current working directory. <span style="color:green">[Optional]</span> |

### Options

| Option                                              | Description                            |
| --------------------------------------------------- | -------------------------------------- |
| `-v` <span style="color:cyan">or</span> `--version` | Displays the current version number.   |
| `-a` <span style="color:cyan">or</span> `--audio`   | Download audio only, skipping prompts. |
| `-f` <span style="color:cyan">or</span> `--footage` | Download video only, skipping prompts. |


## 🕵️‍♂️ Examples

For lots of examples, check them out [here](https://github.com/Hetari/pyutube/blob/main/EXAMPLES.md)! Take a deep dive and discover all the ways to use Pyutube. 🚀

## 🥰 Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you want to change.
please follow the [contributing guidelines](https://github.com/Hetari/pyutube/blob/main/CONTRIBUTING.md)

## 📎 License

This project is licensed under the [MIT License](https://github.com/Hetari/pyutube/blob/main/LICENSE.md).

## 📸 Screenshots

<!-- for pypi only -->
<div style="text-align: center;">
   <p>Download video with specify the save location</p>
   <a href="https://ibb.co/0JkdkQy">
      <img src="https://i.ibb.co/7yH6Hbt/image1.png" alt="Download video with specify the save location">
   </a>
   <p>Chose what type you want to download</p>
   <a href="https://ibb.co/Kb6qjmg">
      <img src="https://i.ibb.co/sbjwvt4/image2.png" alt="Chose what type you want to download">
   </a>
   <p>Chose what what resolution you want to download(if the type is video)</p>
   <a href="https://ibb.co/7ymCS79">
      <img src="https://i.ibb.co/h8z9gpq/image4.png" alt="Chose what resolution you want to download">
   </a>
   <p>If you download a playlist, you can choose what video you want to download, or even all of them</p>
   <a href="https://ibb.co/0qwkQNm">
      <img src="https://i.ibb.co/1ZS3bV7/Screenshot-from-2024-04-11-16-42-29.png" alt="If you download a playlist, you can choose what video you want to download, or even all of them"/>
   </a>
<br /><br />
 <p>Do not know how to use it? just type <code>pyutube --help</code></p>
  <a href="https://ibb.co/LhT6r3r">
      <img src="https://i.ibb.co/WprF0L0/image5.png" alt="image5">
   </a>
</div>

## ⏳ Todo List
- [x] **Notification System**    
- [x] **Auto Update package if new version available**
- [x] **Support Optional Numbering for Downloaded Playlist Videos**
- [ ]  **Improve code health**
- [ ] **Support downloading sounds (mp3 format not a audio/mp4)**
- [ ] **Support Subtitles Download**
- [ ] **Support setting for downloading folder**
- [ ] **Download Thumbnails with Videos and Audio**

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pyutube",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "youtube, download, cli, pyutube, pytubefix, pytube, youtube-dl",
    "author": "Ebraheem Alhetari",
    "author_email": "hetari4all@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/e5/9b/37a5b958e96052e105a982a0617ddad99f35f13a34f56e4789d6a1dcc263/pyutube-1.4.13.tar.gz",
    "platform": "Linux",
    "description": "# \ud83d\udcf9 Pyutube - The Simplest YouTube Downloader CLI\n\n### Enjoying my project? Please show your appreciation by starring it on GitHub! \u2b50\n<a href=\"https://github.com/Hetari/pyutube\">\n  <img src=\"https://img.shields.io/pypi/v/pyutube.svg?style=flat&label=Version\" alt=\"Version\">\n</a>\n<a href=\"https://pepy.tech/projects/pyutube\">\n  <img src=\"https://static.pepy.tech/badge/pyutube\" alt=\"Downloads\">\n</a>\n<a href=\"https://pepy.tech/projects/pyutube\">\n  <img src=\"https://static.pepy.tech/badge/pyutube/month\" alt=\"Downloads per Month\">\n</a>\n<a href=\"https://pepy.tech/projects/pyutube\">\n  <img src=\"https://static.pepy.tech/badge/pyutube/week\" alt=\"Downloads per Week\">\n</a>\n\n<br />\n<br />\n\n> [!NOTE]\n> `Pyutube` is built on top of `pytubefix`, make sure to have the latest version of `pytubefix` by running:\n> ```bash\n> pip install --upgrade pytubefix\n> ```\n\n<a href=\"https://ibb.co/27wcFYN\">\n   <img src=\"https://i.ibb.co/MDbPg56/Screenshot-from-2024-04-08-21-38-02-transformed.png\" alt=\"Pyutube\" style=\"width: 100%;\">\n</a>\n\n> [!NOTE]\n> Have **a new feature**? Please don't hesitate to [tell me](https://github.com/Hetari/pyutube/issues/new)!\n\n\n## \ud83e\udd14 why `pyutube`?\n\nThis command-line wizard lets you download YouTube videos or playlists straight from your `Terminal`, powered by [Pytubefix](https://pytubefix.readthedocs.io/). It works like a charm on Windows, Mac, and Linux, so you can rock it on any platform.\n\nWhile other tools make you wade through a swamp of settings and configs, `Pyutube` keeps it simple. Just drop in your URL, and voil\u00e0! It\u2019ll take you on a smooth ride to your favorite videos, no complex options needed\u2014just fun downloading! \ud83d\udd25\n\n## \ud83d\udee0\ufe0f Installation\n\nGetting `Pyutube` up and running is a breeze! First, ensure you have [Python](https://www.python.org) installed. Just pop open your terminal and type:\n\n```bash\npython --version\n```\n\nIf you see something like `Python 3.x`, you\u2019re all set! If not, head over to [Python's downloads page](https://www.python.org/downloads/) to grab it.\n\nOnce you\u2019re good to go, install `Pyutube` with a single command:\n\n```bash\npip install pyutube\n```\n\nAnd just like that, you\u2019re ready to download some awesome videos! \ud83c\udf89\n\n## \ud83d\udcc8 Upgrade\n\nStay in the loop with the latest features on [GitHub](https://github.com/Hetari/pyutube)! To upgrade your `Pyutube` tool, simply run:\n\n```bash\npip install --upgrade pyutube\n```\n\nThen you\u2019re all set to keep downloading from your `Terminal`! \ud83e\udd73\n\n\n## \ud83e\uddb8 Quick Start\n\nGetting started with `Pyutube` is a piece of cake! Just use the following command style:\n\n```bash\npyutube \"YOUTUBE_LINK\" [PATH]\n```\n\n> [!NOTE]\n> The `[URL]` is <span style=\"color:red\">[Required]</span> and it should be between `\"\"`<br/>\n> The `[PATH]` is optional\u2014if you don\u2019t specify one, it\u2019ll save to your current terminal directory. Easy-peasy!\n\n\n## \ud83d\udc68\u200d\ud83d\udcbb Usage\n\n#### Arguments\n\n| Arguments | Description                                                                                                          |\n| --------- | -------------------------------------------------------------------------------------------------------------------- |\n| `URL`     | The `URL` of the YouTube video. This argument is <span style=\"color:red\">[Required]</span>.                          |\n| `PATH`    | The `path` to save the video. Defaults to the current working directory. <span style=\"color:green\">[Optional]</span> |\n\n### Options\n\n| Option                                              | Description                            |\n| --------------------------------------------------- | -------------------------------------- |\n| `-v` <span style=\"color:cyan\">or</span> `--version` | Displays the current version number.   |\n| `-a` <span style=\"color:cyan\">or</span> `--audio`   | Download audio only, skipping prompts. |\n| `-f` <span style=\"color:cyan\">or</span> `--footage` | Download video only, skipping prompts. |\n\n\n## \ud83d\udd75\ufe0f\u200d\u2642\ufe0f Examples\n\nFor lots of examples, check them out [here](https://github.com/Hetari/pyutube/blob/main/EXAMPLES.md)! Take a deep dive and discover all the ways to use Pyutube. \ud83d\ude80\n\n## \ud83e\udd70 Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you want to change.\nplease follow the [contributing guidelines](https://github.com/Hetari/pyutube/blob/main/CONTRIBUTING.md)\n\n## \ud83d\udcce License\n\nThis project is licensed under the [MIT License](https://github.com/Hetari/pyutube/blob/main/LICENSE.md).\n\n## \ud83d\udcf8 Screenshots\n\n<!-- for pypi only -->\n<div style=\"text-align: center;\">\n   <p>Download video with specify the save location</p>\n   <a href=\"https://ibb.co/0JkdkQy\">\n      <img src=\"https://i.ibb.co/7yH6Hbt/image1.png\" alt=\"Download video with specify the save location\">\n   </a>\n   <p>Chose what type you want to download</p>\n   <a href=\"https://ibb.co/Kb6qjmg\">\n      <img src=\"https://i.ibb.co/sbjwvt4/image2.png\" alt=\"Chose what type you want to download\">\n   </a>\n   <p>Chose what what resolution you want to download(if the type is video)</p>\n   <a href=\"https://ibb.co/7ymCS79\">\n      <img src=\"https://i.ibb.co/h8z9gpq/image4.png\" alt=\"Chose what resolution you want to download\">\n   </a>\n   <p>If you download a playlist, you can choose what video you want to download, or even all of them</p>\n   <a href=\"https://ibb.co/0qwkQNm\">\n      <img src=\"https://i.ibb.co/1ZS3bV7/Screenshot-from-2024-04-11-16-42-29.png\" alt=\"If you download a playlist, you can choose what video you want to download, or even all of them\"/>\n   </a>\n<br /><br />\n <p>Do not know how to use it? just type <code>pyutube --help</code></p>\n  <a href=\"https://ibb.co/LhT6r3r\">\n      <img src=\"https://i.ibb.co/WprF0L0/image5.png\" alt=\"image5\">\n   </a>\n</div>\n\n## \u23f3 Todo List\n- [x] **Notification System**    \n- [x] **Auto Update package if new version available**\n- [x] **Support Optional Numbering for Downloaded Playlist Videos**\n- [ ]  **Improve code health**\n- [ ] **Support downloading sounds (mp3 format not a audio/mp4)**\n- [ ] **Support Subtitles Download**\n- [ ] **Support setting for downloading folder**\n- [ ] **Download Thumbnails with Videos and Audio**\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Awesome CLI to download YouTube videos (as video or audio)/shorts/playlists from the terminal",
    "version": "1.4.13",
    "project_urls": {
        "Author": "https://github.com/Hetari",
        "Bug Tracker": "https://github.com/Hetari/pyutube/issues",
        "Documentation": "https://github.com/Hetari/pyutube",
        "Homepage": "https://github.com/Hetari/pyutube",
        "Source Code": "https://github.com/Hetari/pyutube"
    },
    "split_keywords": [
        "youtube",
        " download",
        " cli",
        " pyutube",
        " pytubefix",
        " pytube",
        " youtube-dl"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "442d8b3e94c82e96a9a08b6a3f08b86311c0f19710f992785cb06b0015bb3ddb",
                "md5": "a508e4069dcaab2b7c3ece61676cc3b4",
                "sha256": "6a42407dadfb5ee8c66259d2f7946a9dbb71105bfcadc735698dbd2a4fe9d3bb"
            },
            "downloads": -1,
            "filename": "pyutube-1.4.13-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a508e4069dcaab2b7c3ece61676cc3b4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 20432,
            "upload_time": "2024-12-31T14:43:17",
            "upload_time_iso_8601": "2024-12-31T14:43:17.378595Z",
            "url": "https://files.pythonhosted.org/packages/44/2d/8b3e94c82e96a9a08b6a3f08b86311c0f19710f992785cb06b0015bb3ddb/pyutube-1.4.13-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e59b37a5b958e96052e105a982a0617ddad99f35f13a34f56e4789d6a1dcc263",
                "md5": "a8eb0f6e269d6a2b32e01c490fa37f55",
                "sha256": "59ffdb9c46adc184976eed08a70625affe708031010d975fc04a86d45628f112"
            },
            "downloads": -1,
            "filename": "pyutube-1.4.13.tar.gz",
            "has_sig": false,
            "md5_digest": "a8eb0f6e269d6a2b32e01c490fa37f55",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 19325,
            "upload_time": "2024-12-31T14:43:20",
            "upload_time_iso_8601": "2024-12-31T14:43:20.653900Z",
            "url": "https://files.pythonhosted.org/packages/e5/9b/37a5b958e96052e105a982a0617ddad99f35f13a34f56e4789d6a1dcc263/pyutube-1.4.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-31 14:43:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Hetari",
    "github_project": "pyutube",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "setuptools",
            "specs": [
                [
                    "==",
                    "75.6.0"
                ]
            ]
        },
        {
            "name": "typer",
            "specs": [
                [
                    "==",
                    "0.15.1"
                ]
            ]
        },
        {
            "name": "requests",
            "specs": [
                [
                    "==",
                    "2.32.3"
                ]
            ]
        },
        {
            "name": "rich",
            "specs": [
                [
                    "==",
                    "13.9.4"
                ]
            ]
        },
        {
            "name": "yaspin",
            "specs": [
                [
                    "==",
                    "3.1.0"
                ]
            ]
        },
        {
            "name": "pytubefix",
            "specs": [
                [
                    "==",
                    "8.8.1"
                ]
            ]
        },
        {
            "name": "inquirer",
            "specs": [
                [
                    "==",
                    "3.4.0"
                ]
            ]
        },
        {
            "name": "termcolor",
            "specs": [
                [
                    "==",
                    "2.3.0"
                ]
            ]
        },
        {
            "name": "moviepy",
            "specs": [
                [
                    "==",
                    "2.1.1"
                ]
            ]
        }
    ],
    "lcname": "pyutube"
}
        
Elapsed time: 0.38519s