Ljzd-PRO / Ljzd-PRO/KToolBox

EASY READY-TO-GO TUTORIAL: CLICK HERE TO GET TAUGHT STEP BY STEP HOW TO USE THE PROGRAM

Open
#141 4 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
TypeScript
Stars
579
Forks
26
PR merge metrics
No merged PRs in 30d

Description

Hi, I write this small post in order to help future people, and maybe hint OP to update the tutorial website.

  1. Go to the website https://ktoolbox.readthedocs.io/latest/
  2. Go to CMD (or your favorite command prompter), and write "pip3 install ktoolbox" without the two".
  3. Go to the folder/directory where you plan to start your download, there, create a file called "prod.env"
  4. Open "prod.env" with notepad/notepad++/etc
  5. There, write inside of it this next:
KTOOLBOX_JOB__POST_DIRNAME_FORMAT={id} {title} {published} {user} {service}
KTOOLBOX_JOB__POST_STRUCTURE__ATTACHMENTS=./
KTOOLBOX_JOB__COUNT=1
KTOOLBOX_JOB__SEQUENTIAL_FILENAME=True
KTOOLBOX_JOB__FILENAME_FORMAT=[{title}]_{}

5.1. EXPLAINATION: Each line modifies the way the program works in different ways...

  • the first changes the name of the sub-folders created for an artist.
  • the second removes the sub-folder inside of the subfolders created, putting all in the same folder for simplicity
  • the third helps with not overloading kemono-servers by downloading 1 file at a time (and potentially avoiding getting banned i think?)
  • the fourth puts a counter in the downloaded files, to avoid non-perfect copies of files from being downloaded twice (the Ktoolbox is automatized to consider copies certain images which are similar as 100% identical, which can be problematic with alternate-version images, which accidentally can be considered identical but in reality they are not, thus, not downloading all versions uploaded).
  • the fifth changes the names of the files downloaded to using their upload title name combined with the fourth line to appropriately do a good job together.
    ... This is what I remember from the top of my mind, for a better way to change the "prod.env" file check the website.
  1. In your folder/directory path, write CMD and then there write one of the two next:
ktoolbox sync-creator [WEBSITE-ENTIRE-ARTIST-URL-GOES-HERE]
ktoolbox download-post  [WEBSITE-SPECIFIC-POST-URL-GOES-HERE]

6.1. If you create a .bat file, you can place it in the same folder location as your .env file. And inside of the .bat file, you can put your ktoolbox sync-creator [WEBSITE-ENTIRE-ARTIST-URL-GOES-HERE] in there, one after another, this way, you can download every artist you want automatically and easily.

  1. This step is important, but you wont be able to do it without another software paid or free (I use Clone File Checker which is paid), and is to delete 100% identical files, which sometimes kemono.com kind of glitches out and creates identical files, which when downloading all to avoid the issue of potential similar alternate-versions getting skipped over, you end up with a lot of repeated data.

  2. Im certain there is more tips and tricks for KToolBox, but im not that experienced with the program, you should read and research on your own to maximize the efficiency on it. Cheers.

UPDATE 1: Installing a new version of phyton, and upgrading ktoolbox.

  1. when asked to uninstall phyton, go to bottom left in 'applications and features', in there find python and click on 'modify', click accept, and in there use THAT uninstall to properly uninstall python
  2. when installing the new python, check for the both the boxes on 'add to path exe' and 'allow admin privileges to python'
  3. Uninstall pipx with pip uninstall pipx. Go to the location where it was installed and remove the path = C:\Users\DAN\pipx. Go to bottom left, click on Windows POWERSHELL, and write get-command pipx to check if no other corrupted version of pipx exists to remove them (https://stackoverflow.com/questions/70059862/pipx-install-path-change)
  4. use CMD command with:
    python -m pip install pipx
    python -m pip install --upgrade pip
    python -m pipx ensurepath
  5. use CMD command pipx install ktoolbox[urwid,winloop]. If you use Linus or MAC use pipx install ktoolbox[urwid,uvloop].

That was it for me.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the tutorial at https://ktoolbox.readthedocs.io/latest/ and checking the documented Python, pipx, and ktoolbox commands against the installation steps in this issue. Done means the tutorial clearly covers setup, prod.env configuration, creator or post downloads, and the platform-specific installation commands without relying on this issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, shell
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.