Skip to main content

A useful CLI tool for downloading posts in Kemono.party / .su

Project description

logo

KToolBox

KToolBox is a useful CLI tool for downloading posts content in Kemono.party / Kemono.su

Version MIT Last Commit codecov Documentation Status Platform Win | Linux | macOS

English | 中文

Preview

Features

  • Support for multi-thread downloads (technically, coroutine)
  • Retry after download failed
  • Ability to download individual post as well as all post by a specified creator/artist
  • Update downloaded creator/artist directories to the latest status
  • Customize the structure of downloaded post/creator directories
  • Search for creators/artists and posts, and export the results
  • Cross-platform support & iOS shortcuts available
  • For Coomer.su / Coomer.party support, check document Coomer for more.

Dev Plan

  • Add a Fluent Design style GUI
  • Add uvloop support for Unix platform

Tutorial

See documentation for more details.

Installation

  • Normal

    pip3 install ktoolbox
    
  • For a-Shell

    pip3 install ktoolbox-pure-py
    

Command

For more information, use the help command or goto Command page.

❓ Get general help

ktoolbox -h

❓ Get help of a command

ktoolbox download-post -h

⬇️🖼️ Download a specific post

ktoolbox download-post https://kemono.su/fanbox/user/49494721/post/6608808

If some files failed to download, you can try to execute the command line again, the downloaded files will be skipped.

⬇️🖌️ Download all posts from a creator

ktoolbox sync-creator https://kemono.su/fanbox/user/9016

By default, you will get a creator-indices.ktoolbox file in the creator directory, you can use it to update the directory anytime.

🔄️ Update a downloaded creator directory

ktoolbox sync-creator https://kemono.su/fanbox/user/641955 --update-with=./xxx/creator-indices.ktoolbox

The creator-indices.ktoolbox file contains the information and filepath of posts inside the directory.

iOS Shortcuts

Goto Shortcuts for iOS page for more details.

Configuration

Goto Configuration-Guide page for more details.

Other Branches

  • Pure Python branch: 🔗pure-py
    • Use pydantic v1 so that cargo is not needed for installation
    • For example, you can use it on iOS terminal App a-Shell
    • 🔗PyPI
  • Development branch: 🔗devel

About Kemono

Description from https://kemono.su :

Kemono is a public archiver for:

  • Patreon
  • Pixiv Fanbox
  • Discord
  • Fantia
  • Afdian
  • Boosty
  • DLsite
  • Gumroad
  • SubscribeStar

Contributors here upload content and share it here for easy searching and organization.
To get started viewing content, either search for creators on the artists page, or search for content on the posts page.

Code Coverage

codecov.io

License

KToolBox is licensed under MIT.

Copyright © 2023 by Ljzd-PRO.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ktoolbox-0.3.5.tar.gz (22.8 kB view details)

Uploaded Source

Built Distribution

ktoolbox-0.3.5-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

Details for the file ktoolbox-0.3.5.tar.gz.

File metadata

  • Download URL: ktoolbox-0.3.5.tar.gz
  • Upload date:
  • Size: 22.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.2.0-1018-azure

File hashes

Hashes for ktoolbox-0.3.5.tar.gz
Algorithm Hash digest
SHA256 4d8e997fea743a6e416f608622d3652ec9cc57a7a2fdd3935db88cba3656077e
MD5 a247c250b000d9a80cfb314c7ca842ba
BLAKE2b-256 e0f8619d3863ba09c407ea84499f4d23115a147dd31ea280dd308ad28d116856

See more details on using hashes here.

Provenance

File details

Details for the file ktoolbox-0.3.5-py3-none-any.whl.

File metadata

  • Download URL: ktoolbox-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 31.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.2.0-1018-azure

File hashes

Hashes for ktoolbox-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a0706da23fa12fe9f59f983be69d73f3fe1c8ad1540519533d89aa0fa1b8940b
MD5 c92e2ce9dfb7a9242351806b8c0878bd
BLAKE2b-256 192739e3b43312740333114acd14ded9a5abf26a8928e7c8acb19bc33e0bfbe7

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page