pyyoutube 1.0.1
A simple cli tool for downloading YouTube videos
License: MIT
Requires Python: >=3.7

<!--
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
-->

<!-- PROJECT LOGO -->
<br />
<p align="center">
  <img src="https://mjn-reame-logos.s3.us-east-2.amazonaws.com/pyyoutube.png" alt="Logo" width="80">

  <h3 align="center">PyYouTube</h3>

  <p align="center">
   Easily download YouTube videos from the terminal
  </p>
</p>

<!-- TABLE OF CONTENTS -->
<details open="open">
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
      </ul>
    </li>
    <li><a href="#installation">Installation</a></li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#roadmap">Roadmap</a></li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
    <li><a href="#acknowledgements">Acknowledgements</a></li>
  </ol>
</details>

<!-- ABOUT THE PROJECT -->

## About The Project

Instead of using that sketchy website that probably will give your computer a
virus when using their downloader, use PyYouTube. It is simple, minimalistic,
and ease of use makes it the perfect tool to download youtube videos. See Usage
to learn how to use PyYouTube. Cheers! 🤟🏼

### Built With

- [Python](https://www.python.org/)
- [YouTube-dl](https://github.com/ytdl-org/youtube-dl)
- [click](https://click.palletsprojects.com/en/8.0.x/)

<!-- GETTING STARTED -->

## Installation

### Using Pip

```sh
pip install pyyoutube
```

### Manual

```sh
git clone git@github.com:michaelnavs/PyYouTube.git
```

```sh
cd PyYouTube
```

```sh
python setup.py install
```

<!-- USAGE EXAMPLES -->

## Usage

### Download a video

```sh
pyyoutube download <enter video url>
```

_Videos are written to downloads folder by default_

### Specify folder to save the video to

```sh
pyyoutube download <video url> <path/to/folder>
```

<!-- ROADMAP -->

## Roadmap

See the [open issues](https://github.com/michaelnavs/PyYouTube/issues) for a list of proposed features (and known issues).

<!-- CONTRIBUTING -->

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

<!-- LICENSE -->

## License

Distributed under the MIT License. See `LICENSE` for more information.

<!-- CONTACT -->

## Contact

Michael Navarro - [@michaeljnavs](https://twitter.com/michaeljnavs)

<!-- ACKNOWLEDGEMENTS -->

## Acknowledgements

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

<!--
[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
[contributors-url]: https://github.com/michaelnavs/PyYouTube/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
[forks-url]: https://github.com/michaelnavs/PyYouTube/network/members
[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
[stars-url]: https://github.com/michaelnavs/PyYouTube/stargazers
[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
[issues-url]: https://github.com/michaelnavs/PyYouTube/issues
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
[license-url]: https://github.com/michaelnavs/PyYouTube/blob/master/LICENSE.txt
-->