https://github.com/timotheemm/cli-youtube-downloader
CLI YouTube Downloader using Python
https://github.com/timotheemm/cli-youtube-downloader
begginer-friendly cli open-source python python3 pytube tqdm youtube youtube-downloader
Last synced: 8 months ago
JSON representation
CLI YouTube Downloader using Python
- Host: GitHub
- URL: https://github.com/timotheemm/cli-youtube-downloader
- Owner: timotheeMM
- License: mit
- Created: 2023-11-19T17:16:53.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-26T16:36:47.000Z (over 1 year ago)
- Last Synced: 2024-01-26T17:41:13.654Z (over 1 year ago)
- Topics: begginer-friendly, cli, open-source, python, python3, pytube, tqdm, youtube, youtube-downloader
- Language: Python
- Homepage:
- Size: 3.17 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
YOUTUBE DOWNLOADER (CLI version)
## What is this project ?
This project is a command line version of a YouTube downloader. This version is coded with Python and its [pytube](https://github.com/pytube/pytube) library.
## Run the project
Follow these steps to run the YouTube Downloader:
1. Go to the [repository homepage](https://github.com/timotheeMM/cli-youtube-downloader).
2. Click on the green "<> Code" button, go to the "Local" tab and download the ZIP.
3. Unpack the zip file.
4. Install Python if not done by going to the [official website](https://www.python.org/downloads/) and following the instructions for your operating system.
5. Open a terminal or a command prompt and go to the project directory. For example:
```sh
cd Downloads/cli-youtube-downloader-main/
```
6. Install the necessary packages for the program with:
```sh
python3 -m pip install -r requirements.txt
```
7. Navigate with the cd command to the "scr" folder:
```sh
cd src/
```
8. Run the main.py file by doing:
```sh
python3 main.py
```
9. Follow the on-screen instructions. When you will download a video, you will find it in the "downloads" folder.
## You want to contribute ?
If you want to contribute to this project, you are welcome! For this, there are a few steps:
1. Create a fork of this project in your GitHub account.
2. Clone this fork on your machine with:
```sh
# make sure that git is installed before doing this
git clone https://github.com/your-username/cli-youtube-downloader.git
```
3. Create a new branch that describes what you want to do by entering:
```sh
git checkout -b my-branch
```
4. Make your changes.
> Important: add your GitHub username to the CONTRIBUTORS.md file following the syntax of the creator.
5. Add the files you have modified:
```sh
git add .
```
6. Make a commit where you say everything you’ve done:
```sh
git commit -m "change... and add..."
```
> Please start your commit with a lowercase letter to ensure continuity of commit history
7. Push your changes to GitHub:
```sh
git push -u origin my-branch
```
8. Make a pull request by going to the project fork page and clicking on "Contribute > Open pull request". A window will open, and you will be able to explain in more detail all the changes you have made.
9. Validate and then wait for validation... 😊
💡 You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star!
## License
This project is under a [MIT license](https://github.com/timotheeMM/cli-youtube-downloader/blob/main/LICENSE).