Skip to content

Commit

Permalink
📝Update readme to add badge and GIF examples.
Browse files Browse the repository at this point in the history
  • Loading branch information
debakarr authored Mar 4, 2023
1 parent 99b2f7f commit 4ccdd87
Showing 1 changed file with 48 additions and 12 deletions.
60 changes: 48 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,32 @@
# :tv: kisskh-dl

Simple downloaded for https://kisskh.me/
<div align="center">
<img src="https://i.imgur.com/nhQtOZa.png">
<br>
<strong><i>Simple downloaded for https://kisskh.me/</i></strong>
<br>
<a href="https://pypi.org/project/kisskh-downloader/">
<img src="https://img.shields.io/pypi/v/kisskh-downloader?style=for-the-badge">
</a>
<img src="https://img.shields.io/github/actions/workflow/status/Dibakarroy1997/kisskh-dl/pull-request.yml?style=for-the-badge">
<img src="https://img.shields.io/pypi/dm/kisskh-downloader?style=for-the-badge">
</div>

---

## :inbox_tray: Installation
👋 Welcome to the kisskh-downloader README! This package is a simple command-line tool for downloading shows from https://kisskh.me/. Here's everything you need to know to get started:

## 💻 Installation

To install kisskh-downloader, simply run the following command:

```console
pip install -U kisskh-downloader
```

## :books: Usage
## 📚 Usage

After installing the package, you can use the `kisskh dl` command to download shows from the command line.

```console
kisskh dl --help
Expand All @@ -27,42 +43,62 @@ Options:
--help Show this message and exit.
```

### :high_brightness: Direct download entire series in highest quality available
Here are some examples:

### 🔗 Direct download entire series in highest quality available in current folder

```console
kisskh dl "https://kisskh.me/Drama/Money-Heist--Korea---Joint-Economic-Area?id=5044"
kisskh dl "https://kisskh.me/Drama/Island-Season-2?id=7000" -o .
```

### :mag_right: Search and download entire series in highest quality available
![Download all using URL](https://i.imgur.com/cvKYqK3.gif)


### 🔍 Search and download entire series in highest quality available in current folder

```console
kisskh dl "Stranger Things"
kisskh dl "Stranger Things" -o .
1. Stranger Things - Season 4
2. Stranger Things - Season 1
3. Stranger Things - Season 2
4. Stranger Things - Season 3
Please select one from above: 1
```

### :arrow_forward: Download specific episodes with specific quality
![Download all using URL](https://i.imgur.com/mLPqjgj.gif)

### ⬇️ Download specific episodes with specific quality

> :exclamation: Note that if the selected quality is not available, it will try to get something lower than that quality. If that also is not available, it will try to get the best quality available.
Downloads episode 4 to 8 of `Alchemy of Souls` in 720p:
```console
kisskh dl "https://kisskh.me/Drama/Alchemy-of-Souls?id=5043" -f 4 -l 8 -q 720p
kisskh dl "https://kisskh.me/Drama/Alchemy-of-Souls?id=5043" -f 4 -l 8 -q 720p -o .
```

![Download range of episodes](https://i.imgur.com/Q6697pa.gif)

Downloads episode 3 of `A Business Proposal` in 720p:
```console
kisskh dl "https://kisskh.me/Drama/A-Business-Proposal?id=4608" -f 3 -l 3 -q 720p
kisskh dl "https://kisskh.me/Drama/A-Business-Proposal?id=4608" -f 3 -l 3 -q 720p -o .
```

![Download single episode](https://i.imgur.com/cNlED8m.gif)

You can also dowload single episode by providing the episode URL

```console
kisskh dl "https://kisskh.me/Drama/A-Business-Proposal/Episode-3?id=4608&ep=86439&page=0&pageSize=100" -o .
```

For more options, use the `--help` flag.

---

# :beetle: DEBUG
# 🐞 DEBUG

To enable debugging, use the `-vv` flag while running `kisskh dl`.

Use -vv flag while running `kisskh dl`
```console
kisskh -vv dl "https://kisskh.me/Drama/A-Business-Proposal?id=4608" -f 3 -l 3 -q 720p
```
Expand Down

0 comments on commit 4ccdd87

Please sign in to comment.