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.2.tar.gz (22.7 kB view details)

Uploaded Source

Built Distribution

ktoolbox-0.3.2-py3-none-any.whl (30.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ktoolbox-0.3.2.tar.gz
Algorithm Hash digest
SHA256 a3d25c718eba850e621a977b6e28f280d8c5a29337111c4b51ca23f48e527092
MD5 a47a1a0ec017d2a73bf61987d5788910
BLAKE2b-256 22e9f5423318675c1ab53787665745ade48401a43298e8bb0760d672d3414579

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for ktoolbox-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 90e2178f677c24addd07e94388225fc3c57c1f82764cc8ae256a72224fa997bd
MD5 a35785ee1f71cc5ae1e032c782dd2ae1
BLAKE2b-256 9a31303bb277ea5a0e5c37b779feb2e26e895242387df5400cab31adecdd1136

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