Metadata-Version: 2.1
Name: ktkkt-downloader
Version: 1.0.0
Summary: downloader for videos on ktkkt.cc
Home-page: https://github.com/r1y5i/ktkkt-downloader
Author: r1y5i
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.md

# ktkkt-downloader #

## About ##
A tool to get anime from [ktkkt.cc](https://www.ktkkt.cc/) with CLI (Command Line Interface) and GUI (Graphical User Interface).
It currently supports to download one single episode / all episodes in a series.

## Prerequisites ##
To running this tool, please make sure the following prerequisites are ready:
* [FFmpeg](https://www.ffmpeg.org/)

## Usage (Package) ##
```
from ktkkt_downloader import KtkktDownloader
downloader = KtkktDownloader(args.directory)

# download all episodes in a series (e.g. 鬼滅之刃粵語)
series_url = "https://www.ktkkt.cc/movie/index15170.html"
downloader.download_series(series_url)

# download single episode (e.g. 鬼滅之刃粵語 EP.01)
episode_url = "https://www.ktkkt.cc/play/15170-0-0.html"
downloader.download_episode(episode_url)
```

## Usage (Standalone) ##
Before running the application, required packages need to be installed by following command:
```
$ python -m pip install -r requirements.txt
```

### CLI (Command Line Interface) ###
```
# download single episode
$ python __main__.py -d OUTPUT_DIR -u TARGET_URL

# download all episodes in a series
$ python __main__.py -d OUTPUT_DIR -u TARGET_URL -a
```

#### Example ####
鬼滅之刃粵語,  
series URL: https://www.ktkkt.cc/movie/index15170.html  
episode 1 URL: https://www.ktkkt.cc/play/15170-0-0.html  
```
# download 鬼滅之刃粵語 episode 1 to /home/ktkkt/ by the episode URL
$ python __main__.py -d /home/ktkkt/ -u https://www.ktkkt.cc/play/15170-0-0.html

# download 鬼滅之刃粵語 all episodes to /home/ktkkt/ by the episode URL
$ python __main__.py -d /home/ktkkt/ -u https://www.ktkkt.cc/play/15170-0-0.html -a

# download 鬼滅之刃粵語 all episodes to /home/ktkkt/ by series URL
$ python __main__.py -d /home/ktkkt/ -u https://www.ktkkt.cc/movie/index15170.html -a
```

### GUI (Graphical User Interface) ###
```
# start gui
$ python __main__.py
```
![ktkkt-downloader screenshot](docs/screenshot.png?raw=true "ktkkt-downloader")
Provide the TARGET_URL, OUTPUT_DIR and then click the buttons to download the single episode / all episodes in a series  

## License ##
[GNU GPL v3.0](LICENSE.md)
