Skip to content

Commit 9a87d15

Browse files
HetariHetari
committed
update the readme
1 parent a30a48e commit 9a87d15

File tree

2 files changed

+117
-128
lines changed

2 files changed

+117
-128
lines changed

‎EXAMPLES.md

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# 🕵️‍♂️ Examples
2+
3+
> [!IMPORTANT]
4+
> For all commands, the **`[the_download_path]`** is optional. If not specified, the video/audio will be saved in the current working directory.
5+
6+
## **1. Show Version:**
7+
8+
Check the current version of `Pyutube`:
9+
10+
```bash
11+
pyutube -v
12+
```
13+
14+
## **2. Download Playlists:**
15+
16+
Eager to grab an entire playlist? Just run:
17+
18+
```bash
19+
pyutube "YOUTUBE_PLAYLIST_LINK" [the_download_path]
20+
```
21+
22+
1. Choose the download format: video or audio.
23+
2. If you select video, pick your desired resolution. For audio, it’ll download everything right away! 🔥
24+
25+
The tool will check all available resolutions from the first video in the playlist and download them in that resolution. 👍
26+
27+
## **3. Download Shorts, Videos, or Audio:**
28+
29+
Ready to download a single short, video, or audio track? Use:
30+
31+
```bash
32+
pyutube "YOUTUBE_LINK" OR "SHORT_LINK" [the_download_path]
33+
```
34+
35+
1. Select the format: video or audio.
36+
2. If it’s a video, choose the resolution; otherwise, the audio downloads immediately! 🔥
37+
38+
Examples:
39+
40+
```bash
41+
pyutube youtu.be/cMPnY7EuZvo
42+
pyutube https://youtube.com/watch?v=cMPnY7EuZvo
43+
```
44+
45+
## **4. Download Audio Immediately:**
46+
47+
Want to grab just the audio? Run:
48+
49+
```bash
50+
pyutube "YOUTUBE_LINK" OR "SHORT_LINK" [the_download_path] -a
51+
```
52+
53+
Examples:
54+
55+
```bash
56+
pyutube cMPnY7EuZvo -a
57+
pyutube -a youtu.be/cMPnY7EuZvo
58+
```
59+
60+
And you’re all set! 🎉
61+
62+
## **5. Download Videos Immediately:**
63+
64+
Need the video fast? Use:
65+
66+
```bash
67+
pyutube <Y"OUTUBE_LINK" OR "SHORT_LINK" [the_download_path] -f
68+
```
69+
70+
1. Choose your desired resolution.
71+
72+
Examples:
73+
74+
```bash
75+
pyutube cMPnY7EuZvo -f
76+
pyutube -f youtu.be/cMPnY7EuZvo
77+
```
78+
79+
Sit back, relax, and enjoy your video! 🎉

‎README.md

+38-128
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,64 @@
1-
# 📹 YouTube Downloader CLI
1+
# 📹 Pyutube - The Simplest YouTube Downloader CLI
22

33
### Enjoying my project? Please show your appreciation by starring it on GitHub! ⭐
44

5-
[![Version](https://img.shields.io/pypi/v/pyutube.svg?style=flat)](https://pypi.org/project/pyutube/)
6-
[![Downloads](https://static.pepy.tech/badge/pyutube)](https://pepy.tech/project/pyutube)
5+
<img src="https://img.shields.io/pypi/v/pyutube.svg?style=flat&label=Version" alt="Version">
6+
<img src="https://static.pepy.tech/badge/pyutube?style=flat&label=Downloads" alt="Downloads">
77

88
> [!NOTE]
9-
> Have a new feature? Please don't hesitate to [tell me](https://github.com/Hetari/pyutube/issues/new)!
9+
> Have **a new feature**? Please don't hesitate to [tell me](https://github.com/Hetari/pyutube/issues/new)!
1010
11-
<!-- for pypi only -->
1211
<a href="https://ibb.co/27wcFYN">
1312
<img src="https://i.ibb.co/MDbPg56/Screenshot-from-2024-04-08-21-38-02-transformed.png" alt="Pyutube" style="width: 100%;">
1413
</a>
1514

16-
<!-- <a href="https://ibb.co/27wcFYN">
17-
<img src="images/pyutube.png" alt="Pyutube" style="width: 100%;">
18-
</a> -->
19-
20-
## 📓 Description
15+
## 🤔 why `pyutube`?
2116

22-
This command-line tool downloads YouTube videos from the `Terminal`, written under [Pytube](https://pytube.io/), and offers a user-friendly interface.
17+
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.
2318

24-
it is cross-platform (Windows, Mac, Linux) and can be used in any terminal.
19+
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! 🔥
2520

26-
## 🤔 why `pyutube`?
21+
## 🛠️ Installation
2722

28-
While other tools offer many features and configurability, `pyutube` simplifies the process, with no need to dive into complex configurations and documentation, such as identifying specific options for downloading audio-only, or how to download a specific resolution, but on `pyutube` just paste the URL and that's it, it will guide you through the process 🔥.
23+
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:
2924

30-
## 🛠️ Installation
25+
```bash
26+
python --version
27+
```
3128

32-
it is easy to install Pyutube, make sure that you have [Python](https://www.python.org) installed. To check if you have it installed, type `python --version` in your terminal. You should see something like `Python 3. x ` otherwise, download and install it from [Python](https://www.python.org/downloads/).
29+
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.
3330

34-
after that, you can install it with the following command:
31+
Once you’re good to go, install `Pyutube` with a single command:
3532

3633
```bash
3734
pip install pyutube
3835
```
3936

37+
And just like that, you’re ready to download some awesome videos! 🎉
38+
4039
## 📈 Upgrade
4140

42-
All the latest updates will be posted on [GitHub](https://github.com/Hetari/pyutube), you can also upgrade the tool via [PyPI](https://pypi.org/project/pyutube/) with this command:
41+
Stay in the loop with the latest features on [GitHub](https://github.com/Hetari/pyutube)! To upgrade your `Pyutube` tool, simply run:
4342

4443
```bash
4544
pip install --upgrade pyutube
4645
```
4746

48-
Then you can use it in your `Terminal` 🥳.
47+
Then you’re all set to keep downloading from your `Terminal`! 🥳
48+
4949

5050
## 🦸 Quick Start
5151

52-
Pyutube is very easy to use, here are examples of its uses:
52+
Getting started with `Pyutube` is a piece of cake! Just use the following command style:
5353

5454
```bash
55-
pyutube YOUTUBE_LINK [PATH]
55+
pyutube "YOUTUBE_LINK" [PATH]
5656
```
5757

58-
> [!NOTE] > `[PATH]` is an optional input, the default value is the `terminal` path where the CLI is running (the current working directory in your terminal).
58+
> [!NOTE]
59+
> The `[URL]` is <span style="color:red">[Required]</span> and it should be between `""`<br/>
60+
> The `[PATH]` is optional—if you don’t specify one, it’ll save to your current terminal directory. Easy-peasy!
61+
5962

6063
## 👨‍💻 Usage
6164

@@ -66,83 +69,27 @@ pyutube YOUTUBE_LINK [PATH]
6669
| `URL` | The `URL` of the YouTube video. This argument is <span style="color:red">[Required]</span>. |
6770
| `PATH` | The `path` to save the video. Defaults to the current working directory. <span style="color:green">[Optional]</span> |
6871

69-
#### Options
70-
71-
| Option | Description |
72-
| --------------------------------------------------- | ---------------------------------------------------------------- |
73-
| `-v` <span style="color:cyan">or</span> `--version` | Show the version number. |
74-
| `-a` <span style="color:cyan">or</span> `--audio` | Download only audio immediately without asking (video or audio). |
75-
| `-f` <span style="color:cyan">or</span> `--footage` | Download only video immediately without asking (video or audio). |
76-
77-
## 🕵️‍♂️ Examples
78-
79-
### **- Show version:**
80-
81-
```bash
82-
pyutube -v
83-
```
84-
85-
### **- Download playlists:**
86-
87-
1. `pyutube <YOUTUBE_PLAYLIST_LINK | PLAYLIST_ID> [the_download_path*]`
72+
### Options
8873

89-
> [!NOTE]
90-
> Don't forget, the path is optional.
91-
92-
1. Then choose the format of the download, video or audio.
93-
2. Choose the resolution if it is a video you want to download, otherwise, choose audio and it will download it all immediately 🔥.
94-
95-
> [!NOTE]
96-
> It will check all resolutions available in the first video in the playlist, then it will download all of them in the same resolution 👍.
97-
98-
### **- Download shorts, videos, or audio:**
99-
100-
1. `pyutube <YOUTUBE_LINK | VIDEO_ID | SHORT_LINK> [the_download_path*]`
101-
102-
> [!NOTE]
103-
> Don't forget, the path is optional.
104-
105-
1. Then choose the format of the download, video or audio.
106-
2. Choose the resolution if it is a video you want to download, otherwise, choose audio and it will download it immediately 🔥.
107-
108-
```bash
109-
pyutube cMPnY7EuZvo
110-
pyutube youtu.be/cMPnY7EuZvo
111-
pyutube https://youtube.com/watch?v=cMPnY7EuZvo
112-
```
113-
114-
### **- Download audio immediately:**
115-
116-
1. `pyutube <YOUTUBE_LINK | VIDEO_ID | SHORT_LINK> [the_download_path*] -a`
117-
118-
```bash
119-
pyutube cMPnY7EuZvo -a
120-
```
121-
122-
or
123-
124-
```bash
125-
pyutube -a youtu.be/cMPnY7EuZvo
126-
```
74+
| Option | Description |
75+
| --------------------------------------------------- | -------------------------------------- |
76+
| `-v` <span style="color:cyan">or</span> `--version` | Displays the current version number. |
77+
| `-a` <span style="color:cyan">or</span> `--audio` | Download audio only, skipping prompts. |
78+
| `-f` <span style="color:cyan">or</span> `--footage` | Download video only, skipping prompts. |
12779

128-
and that's it 🎉.
12980

130-
### **- Download videos immediately:**
81+
## 🕵️‍♂️ Examples
13182

132-
1. `pyutube <YOUTUBE_LINK | VIDEO_ID | SHORT_LINK> [the_download_path*] -f`
133-
2. Choose the resolution.
83+
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. 🚀
13484

135-
```bash
136-
pyutube cMPnY7EuZvo -f
137-
```
85+
## 🥰 Contributing
13886

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

141-
```bash
142-
pyutube -f youtu.be/cMPnY7EuZvo
143-
```
90+
## 📎 License
14491

145-
see the video and relax 🎉.
92+
This project is licensed under the [MIT License](https://github.com/Hetari/pyutube/blob/main/LICENSE.md).
14693

14794
## 📸 Screenshots
14895

@@ -171,40 +118,3 @@ see the video and relax 🎉.
171118
</a>
172119
</div>
173120

174-
<!-- <div style="text-align: center;">
175-
<p>Download video with specify the save location</p>
176-
<a href="https://ibb.co/0JkdkQy">
177-
<img src="images/image1.png" alt="Download video with specify the save location">
178-
</a>
179-
180-
<p>Chose what type you want to download</p>
181-
<a href="https://ibb.co/Kb6qjmg">
182-
<img src="images/image2.png" alt="Chose what type you want to download">
183-
</a>
184-
185-
<p>Chose what what resolution you want to download(if the type is video)</p>
186-
<a href="https://ibb.co/7ymCS79">
187-
<img src="images/image3.png" alt="Chose what resolution you want to download">
188-
</a>
189-
190-
<p>If you download a playlist, you can choose what video you want to download, or even all of them</p>
191-
<a href="https://ibb.co/0qwkQNm">
192-
<img src="images/image4.png" alt="If you download a playlist, you can choose what video you want to download, or even all of them"/>
193-
</a>
194-
195-
<br /><br />
196-
197-
<p>Do not know how to use it? just type <code>pyutube --help</code></p>
198-
<a href="https://ibb.co/LhT6r3r">
199-
<img src="images/image5.png" alt="image5">
200-
</a>
201-
</div> -->
202-
203-
## 🥰 Contributing
204-
205-
Pull requests are welcome. For major changes, please open an issue first to discuss what you want to change.
206-
please follow the [contributing guidelines](https://github.com/Hetari/pyutube/blob/main/CONTRIBUTING.md)
207-
208-
## 📎 License
209-
210-
This project is licensed under the [MIT License](https://github.com/Hetari/pyutube/blob/main/LICENSE.md).

0 commit comments

Comments
 (0)