<p align="center" style="text-decoration:none">
<img align="center" src="https://cdn.jsdelivr.net/gh/Ljzd-PRO/KToolBox@latest/static/repository-open-graph-2.svg" alt="logo">
</p>
<h1 align="center">
KToolBox
</h1>
<p align="center">
KToolBox is a useful CLI tool for downloading posts content in
<a href="https://kemono.su/">Kemono.party / Kemono.su</a>
</p>
<p align="center">
<a href="https://pypi.org/project/ktoolbox" target="_blank">
<img src="https://img.shields.io/github/v/release/Ljzd-PRO/KToolBox?logo=python" alt="Version">
</a>
<a href="./LICENSE">
<img src="https://img.shields.io/github/license/Ljzd-PRO/KToolBox" alt="BSD 3-Clause"/>
</a>
<a href="https://github.com/Ljzd-PRO/KToolBox/activity">
<img src="https://img.shields.io/github/last-commit/Ljzd-PRO/KToolBox/devel" alt="Last Commit"/>
</a>
<a href="https://codecov.io/gh/Ljzd-PRO/KToolBox" target="_blank">
<img src="https://codecov.io/gh/Ljzd-PRO/KToolBox/branch/master/graph/badge.svg?token=5XK9CYQHQN" alt="codecov"/>
</a>
<a href='https://ktoolbox.readthedocs.io/'>
<img src='https://readthedocs.org/projects/ktoolbox/badge/?version=latest' alt='Documentation Status' />
</a>
<a style="text-decoration:none">
<img src="https://img.shields.io/badge/Platform-Windows%20|%20Linux%20|%20macOS-blue" alt="Platform Win | Linux | macOS"/>
</a>
</p>
<p align="center">
<a href="./README.md">English</a> | <a href="./README_zh-CN.md">中文</a>
</p>
<img src="https://cdn.jsdelivr.net/gh/Ljzd-PRO/KToolBox@latest/static/preview-1.png" alt="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](https://ktoolbox.readthedocs.io/latest/coomer/) for more.
## Dev Plan
- [ ] GUI
- [x] Add uvloop support for Unix platform
## Tutorial
See [documentation](https://ktoolbox.readthedocs.io/) for more details.
### Installation
You can use executables from [releases](https://github.com/Ljzd-PRO/KToolBox/releases) page
Manually install:
- Recommend
```bash
pip3 install pipx
pipx install ktoolbox
```
- For [a-Shell](https://github.com/holzschu/a-shell)
```bash
pip3 install ktoolbox-pure-py
```
### Command
For more information, use the help command or goto [Command](https://ktoolbox.readthedocs.io/latest/commands/guide) page.
#### ❓ Get general help
```bash
ktoolbox -h
```
#### ❓ Get help of a command
```bash
ktoolbox download-post -h
```
#### ⬇️🖼️ Download a specific post
```bash
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 posts from a creator
```bash
# Download all posts of the creator/artist
ktoolbox sync-creator https://kemono.su/fanbox/user/9016
# Download latest 10 posts of the creator/artist
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --length=10
# Download latest No.11-No.15 posts of the creator/artist
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --offset=10 --length=5
# Download posts from the creator/artist from 2024-1-1 to 2024-3-1
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --start-time=2024-1-1 --end-time=2024-3-1
```
### iOS Shortcuts
Goto [Shortcuts for iOS](https://ktoolbox.readthedocs.io/latest/shortcut/) page for more details.
### Configuration
- Download 10 files at the same time
- Rename attachments in numerical order
- Prefix the post directory name with its release/publish date
- ...
Goto [Configuration-Guide](https://ktoolbox.readthedocs.io/latest/configuration/guide/) page for more details.
## Other Branches
- Pure Python branch: [🔗pure-py](https://github.com/Ljzd-PRO/KToolBox/tree/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](https://github.com/holzschu/a-shell)
- 🔗[PyPI](https://pypi.org/project/ktoolbox-pure-py/)
- Development branch: [🔗devel](https://github.com/Ljzd-PRO/KToolBox/tree/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
## License
KToolBox is licensed under BSD 3-Clause.
Copyright © 2023 by Ljzd-PRO.
Raw data
{
"_id": null,
"home_page": "https://ktoolbox.readthedocs.io/",
"name": "ktoolbox",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.8.1",
"maintainer_email": null,
"keywords": "kemono, kemono.party, cli-app, downloader, os-independent",
"author": "Ljzd-PRO",
"author_email": "ljzd@office.ljzd-pro.asia",
"download_url": "https://files.pythonhosted.org/packages/0b/78/251ab0d0a93fe75f7b13e0b74fa7488a560c51827fb08754795a13669701/ktoolbox-0.10.0.tar.gz",
"platform": null,
"description": "<p align=\"center\" style=\"text-decoration:none\">\n <img align=\"center\" src=\"https://cdn.jsdelivr.net/gh/Ljzd-PRO/KToolBox@latest/static/repository-open-graph-2.svg\" alt=\"logo\">\n</p>\n\n<h1 align=\"center\">\n KToolBox\n</h1>\n\n<p align=\"center\">\n KToolBox is a useful CLI tool for downloading posts content in\n <a href=\"https://kemono.su/\">Kemono.party / Kemono.su</a>\n</p>\n\n<p align=\"center\">\n <a href=\"https://pypi.org/project/ktoolbox\" target=\"_blank\">\n <img src=\"https://img.shields.io/github/v/release/Ljzd-PRO/KToolBox?logo=python\" alt=\"Version\">\n </a>\n\n <a href=\"./LICENSE\">\n <img src=\"https://img.shields.io/github/license/Ljzd-PRO/KToolBox\" alt=\"BSD 3-Clause\"/>\n </a>\n\n <a href=\"https://github.com/Ljzd-PRO/KToolBox/activity\">\n <img src=\"https://img.shields.io/github/last-commit/Ljzd-PRO/KToolBox/devel\" alt=\"Last Commit\"/>\n </a>\n\n <a href=\"https://codecov.io/gh/Ljzd-PRO/KToolBox\" target=\"_blank\">\n <img src=\"https://codecov.io/gh/Ljzd-PRO/KToolBox/branch/master/graph/badge.svg?token=5XK9CYQHQN\" alt=\"codecov\"/>\n </a>\n\n <a href='https://ktoolbox.readthedocs.io/'>\n <img src='https://readthedocs.org/projects/ktoolbox/badge/?version=latest' alt='Documentation Status' />\n </a>\n\n <a style=\"text-decoration:none\">\n <img src=\"https://img.shields.io/badge/Platform-Windows%20|%20Linux%20|%20macOS-blue\" alt=\"Platform Win | Linux | macOS\"/>\n </a>\n</p>\n\n<p align=\"center\">\n <a href=\"./README.md\">English</a> | <a href=\"./README_zh-CN.md\">\u4e2d\u6587</a>\n</p>\n\n<img src=\"https://cdn.jsdelivr.net/gh/Ljzd-PRO/KToolBox@latest/static/preview-1.png\" alt=\"Preview\">\n\n## Features\n\n- Support for **multi-thread** downloads (technically, coroutine)\n- **Retry** after download failed\n- Ability to download individual post as well as **all post** by a specified creator/artist\n- **Update downloaded** creator/artist directories to the latest status\n- Customize the **structure** of downloaded post/creator **directories**\n- Search for creators/artists and posts, and **export the results**\n- **Cross-platform** support & **iOS shortcuts** available\n- For Coomer.su / Coomer.party support, check document [Coomer](https://ktoolbox.readthedocs.io/latest/coomer/) for more.\n\n## Dev Plan\n\n- [ ] GUI\n- [x] Add uvloop support for Unix platform\n\n## Tutorial\n\nSee [documentation](https://ktoolbox.readthedocs.io/) for more details.\n\n### Installation\n\nYou can use executables from [releases](https://github.com/Ljzd-PRO/KToolBox/releases) page\n\nManually install:\n\n- Recommend\n ```bash\n pip3 install pipx\n pipx install ktoolbox\n ```\n\n- For [a-Shell](https://github.com/holzschu/a-shell)\n ```bash\n pip3 install ktoolbox-pure-py\n ```\n\n### Command\n\nFor more information, use the help command or goto [Command](https://ktoolbox.readthedocs.io/latest/commands/guide) page.\n \n#### \u2753 Get general help\n```bash\nktoolbox -h\n```\n \n#### \u2753 Get help of a command\n```bash\nktoolbox download-post -h\n```\n\n#### \u2b07\ufe0f\ud83d\uddbc\ufe0f Download a specific post\n```bash\nktoolbox download-post https://kemono.su/fanbox/user/49494721/post/6608808\n```\n\nIf some files failed to download, you can try to execute the command line again, \nthe downloaded files will be **skipped**.\n \n#### \u2b07\ufe0f\ud83d\udd8c\ufe0f Download posts from a creator\n```bash\n# Download all posts of the creator/artist\nktoolbox sync-creator https://kemono.su/fanbox/user/9016\n\n# Download latest 10 posts of the creator/artist\nktoolbox sync-creator https://kemono.su/fanbox/user/9016 --length=10\n\n# Download latest No.11-No.15 posts of the creator/artist\nktoolbox sync-creator https://kemono.su/fanbox/user/9016 --offset=10 --length=5\n\n# Download posts from the creator/artist from 2024-1-1 to 2024-3-1\nktoolbox sync-creator https://kemono.su/fanbox/user/9016 --start-time=2024-1-1 --end-time=2024-3-1\n```\n\n### iOS Shortcuts\n\nGoto [Shortcuts for iOS](https://ktoolbox.readthedocs.io/latest/shortcut/) page for more details.\n\n### Configuration\n\n- Download 10 files at the same time\n- Rename attachments in numerical order\n- Prefix the post directory name with its release/publish date\n- ...\n\nGoto [Configuration-Guide](https://ktoolbox.readthedocs.io/latest/configuration/guide/) page for more details.\n\n\n\n\n## Other Branches\n\n- Pure Python branch: [\ud83d\udd17pure-py](https://github.com/Ljzd-PRO/KToolBox/tree/pure-py)\n - Use pydantic v1 so that cargo is not needed for installation\n - For example, you can use it on iOS terminal App [a-Shell](https://github.com/holzschu/a-shell)\n - \ud83d\udd17[PyPI](https://pypi.org/project/ktoolbox-pure-py/)\n- Development branch: [\ud83d\udd17devel](https://github.com/Ljzd-PRO/KToolBox/tree/devel)\n\n## About Kemono\n\nDescription from https://kemono.su :\n\n> Kemono is a public archiver for:\n> \n> - Patreon\n> - Pixiv Fanbox\n> - Discord\n> - Fantia\n> - Afdian\n> - Boosty\n> - DLsite\n> - Gumroad\n> - SubscribeStar\n> \n> Contributors here upload content and share it here for easy searching and organization. \\\n> To get started viewing content, either search for creators on the artists page, or search for content on the posts page.\n\n## Code Coverage\n\n\n\n## License\n\nKToolBox is licensed under BSD 3-Clause.\n\nCopyright \u00a9 2023 by Ljzd-PRO.\n",
"bugtrack_url": null,
"license": null,
"summary": "A useful CLI tool for downloading posts in Kemono.party / .su",
"version": "0.10.0",
"project_urls": {
"Bug Tracker": "https://github.com/Ljzd-PRO/KToolBox/issues",
"Documentation": "https://ktoolbox.readthedocs.io/",
"Homepage": "https://ktoolbox.readthedocs.io/",
"Repository": "https://github.com/Ljzd-PRO/KToolBox"
},
"split_keywords": [
"kemono",
" kemono.party",
" cli-app",
" downloader",
" os-independent"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "71b5b1288969ac0a923ead57b6c0d9f3eddf27d112b9c518cd454d47fe55a8d0",
"md5": "436d418eb903706ebe0eb57990350743",
"sha256": "a137897a1f204dfa4240e6c32caf9f895ce62a846384877d8625d58609bb3e0e"
},
"downloads": -1,
"filename": "ktoolbox-0.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "436d418eb903706ebe0eb57990350743",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.8.1",
"size": 38757,
"upload_time": "2024-10-26T11:32:39",
"upload_time_iso_8601": "2024-10-26T11:32:39.028921Z",
"url": "https://files.pythonhosted.org/packages/71/b5/b1288969ac0a923ead57b6c0d9f3eddf27d112b9c518cd454d47fe55a8d0/ktoolbox-0.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0b78251ab0d0a93fe75f7b13e0b74fa7488a560c51827fb08754795a13669701",
"md5": "7e6cfe7f919353be239dded9d27d5f4b",
"sha256": "d6cca9c214fe89542fc8e952b6903ae75053c53b649f5be308b2771a50fb7bf7"
},
"downloads": -1,
"filename": "ktoolbox-0.10.0.tar.gz",
"has_sig": false,
"md5_digest": "7e6cfe7f919353be239dded9d27d5f4b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.8.1",
"size": 30132,
"upload_time": "2024-10-26T11:32:40",
"upload_time_iso_8601": "2024-10-26T11:32:40.348006Z",
"url": "https://files.pythonhosted.org/packages/0b/78/251ab0d0a93fe75f7b13e0b74fa7488a560c51827fb08754795a13669701/ktoolbox-0.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-26 11:32:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Ljzd-PRO",
"github_project": "KToolBox",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ktoolbox"
}
JSON
