README.md 2.06 KB
Newer Older
Lauren Liberda's avatar
Lauren Liberda committed
1
# [Haruhi-DL](https://haruhi.download/)
2

Lauren Liberda's avatar
Lauren Liberda committed
3 4 5
[![build status](https://img.shields.io/gitlab/pipeline/laudom/haruhi-dl/master?gitlab_url=https%3A%2F%2Fgit.sakamoto.pl&style=flat-square)](https://git.sakamoto.pl/laudom/haruhi-dl/-/pipelines)
[![PyPI Downloads](https://img.shields.io/pypi/dm/haruhi-dl?style=flat-square)](https://pypi.org/project/haruhi-dl/)
[![License: LGPL 3.0 or later](https://img.shields.io/pypi/l/haruhi-dl?style=flat-square)](https://git.sakamoto.pl/laudom/haruhi-dl/-/blob/master/README.md)
6
[![Sasin stole 70 million PLN](https://img.shields.io/badge/Sasin-stole%2070%20million%20PLN-orange?style=flat-square)](https://www.planeta.pl/Wiadomosci/Polityka/Ile-kosztowaly-karty-wyborcze-Sasin-do-wiezienia-Wybory-odwolane)
Lauren Liberda's avatar
Lauren Liberda committed
7
[![Trans rights!](https://img.shields.io/badge/Trans-rights!-5BCEFA?style=flat-square)](http://transfuzja.org/en/artykuly/trans_people_in_poland/situation.htm)
8

9
This is a fork of [youtube-dl](https://yt-dl.org/), focused on bringing a fast, steady stream of updates. We'll do our best to merge patches to any site, not only youtube.
Daniel Bolton's avatar
Daniel Bolton committed
10

Lauren Liberda's avatar
Lauren Liberda committed
11
Our main repository is on our GitLab: https://git.sakamoto.pl/laudompat/haruhi-dl
Lauren Liberda's avatar
Lauren Liberda committed
12

Lauren Liberda's avatar
Lauren Liberda committed
13
A Microsoft GitHub mirror exists as well: https://github.com/haruhi-dl/haruhi-dl
Lauren Liberda's avatar
Lauren Liberda committed
14

15 16
## Installing

Lauren Liberda's avatar
Lauren Liberda committed
17
haruhi-dl is available on PyPI: [![version on PyPI](https://img.shields.io/pypi/v/haruhi-dl?style=flat-square)](https://pypi.org/project/haruhi-dl/)
18 19 20 21 22 23 24

Install release from PyPI on Python 3.x:
```sh
$ python3 -m pip install --upgrade haruhi-dl
```
Install from master (unstable) on Python 3.x:
```sh
Lauren Liberda's avatar
Lauren Liberda committed
25
$ python3 -m pip install --upgrade git+https://git.sakamoto.pl/laudompat/haruhi-dl.git
26 27
```

Lauren Liberda's avatar
Lauren Liberda committed
28
**Python 2 support is dropped and we recommend to switch to Python 3**, though it may still work.
29

Lauren Liberda's avatar
Lauren Liberda committed
30 31 32 33 34 35 36 37 38 39 40
## Usage

```sh
$ haruhi-dl "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
```
That's it! You just got rickrolled!

Full manual with all options:
```sh
$ haruhi-dl --help
```
41 42
## Contributing

Lauren Liberda's avatar
Lauren Liberda committed
43
If you want to contribute, send us a diff to <contribute@haruhi.download>, or submit a Pull Request on [our mirror at Microsoft GitHub](https://github.com/haruhi-dl/haruhi-dl).