Table of Contents

• Guides & Installation
  • Installing with pip
  • Pulling from GitHub
  • Installing from source
• Usage
  • Configuration
  • Basic Usage
  • Selecting an image to download
• Options
• Supported Sites
• Issues
• Disclaimer

Guides & Installation

Installing with pip

You can install krsite-dl using pip. This is the recommended way to install the script.

pip install krsite-dl

Pulling from GitHub

You can also install krsite-dl by pulling the latest code from GitHub.

git clone -b master git@github.com:krsite-dl/krsite-dl.git

Or

Download the latest release from releases

Then run the following command to install dependencies:

pip3 install -r requirements.txt

Usage

Configuration

User can add krsite-dl.conf file to set default download path. You can put the file in the following locations for automatic detection. This will get overridden by config path specified by -c option.

Windows

%APPDATA%\krsite-dl\krsite-dl.conf

%USERPROFILE%\krsite-dl\krsite-dl.conf

%USERPROFILE%\krsite-dl.conf

Linux

/etc/krsite-dl.conf

~/.config/krsite-dl/krsite-dl.conf

~/krsite-dl.conf

[!NOTE]

The krsite-dl.conf file should contain the following:

[Settings]

base_dir = <path>

Basic Usage

krsite-dl [-h] [-c CONFIG] [-a A] [-d DESTINATION] [-s] [-v] [--no-windows-filenames] [url ...]

krsite-dl https://example.com/1/

krsite-dl https://example.com/1/ https//example.com/2/

[!NOTE]

If you use the source code, you can run the script directly with python3 -m krsite_dl.py or python -m krsite_dl.py.

Download by specifying the download path

Alternatively, you can specify the download path by default by using krsite-dl.config file.

krsite-dl https://example.com -d ~/Pictures/

Download by specifying the config path

krsite-dl -c ~/krsite-dl.conf https://example.com

Downloading from multiple sites in a text file

krsite-dl -a ~/Pictures/list.txt -d ~/Pictures

Selecting an image to download

This will prompt you a list of images to download

krsite-dl https://example.com -s

Issues

[!NOTE] Please make an issue if you encounter any problems or just want to get more sites supported.

Site Name: www.example.com

Site URL (preferably the post page): www.example.com/post/1234

Disclaimer

This program is solely intended for the purpose of easily obtaining images from Korean websites where the images are publicly available and not behind any paywall or login. By using this program, you agree that you are responsible for your own actions and your action afterwards. The author and maintainer of this program is not responsible for any loss or damage caused by the use of this program.