Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sinkaroid/tomoe
An exalted manga & doujinshi downloader with ease
https://github.com/sinkaroid/tomoe
doujinshi hentaifox nhentai pururin
Last synced: about 2 months ago
JSON representation
An exalted manga & doujinshi downloader with ease
- Host: GitHub
- URL: https://github.com/sinkaroid/tomoe
- Owner: sinkaroid
- License: mit
- Created: 2022-03-18T08:52:33.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-04-20T03:06:27.000Z (over 1 year ago)
- Last Synced: 2024-07-30T11:39:05.789Z (about 2 months ago)
- Topics: doujinshi, hentaifox, nhentai, pururin
- Language: Python
- Homepage:
- Size: 159 KB
- Stars: 30
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-indo-projects - Tomoe - A reliable doujinshi downloader for mankind. (Python)
- awesome-indonesia-repo - Tomoe - A reliable doujinshi downloader for mankind. (Python)
README
An exalted doujinshi downloader with ease.
Tomoe is a CLI tool for downloading doujinshi from various doujinboards. It's also has built-in modular bulk download and auto render into PDF (**Portable Document Format**) for it's utility, hopefully will be reusable.
🚀 Commands •
Documentation •
Report Issues
- [Tomoe](#)
- [Features](#features)
- [Tomoe availability](#tomoe-vs-the-doujinboards)
- [Site support](#site-support)
- [Installation](#installation)
- [Prerequisites](#prerequisites)
- [Documentation](https://github.com/sinkaroid/tomoe/wiki)
- [Command usage](#command-usage)
- [Quick examples](#quick-example)
- [Options](#options)
- [Bulk download](#bulk-download)
- [Bulk download using nested list](#bulk-download-using-nested-list)
- [Pronunciation](#pronunciation)
- [Acknowledgements](./CLOSING_REMARKS.md)
- [Legal](#legal)
---
## Tomoe vs. the doujinboards
Tomoe consumes [Jandapress](https://github.com/sinkaroid/jandapress) and uses [janda](https://pypi.org/project/janda/) for the doujin Python library.
**Features availability** Speed or performance may not be accurate because internet connection or API response. Some tests have high resolve time and render a bit longer, because some sources do not provide real extension of an images, tomoe should check and guess it's format.
| Site | Status | Bulk download | Average response |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------- |
| `nhentai` | [](https://github.com/sinkaroid/tomoe/actions/workflows/nhentai.yml) | `Yes` | ~0.52 minutes |
| `pururin` | [](https://github.com/sinkaroid/tomoe/actions/workflows/pururin.yml) | `Yes` | ~0.63 minutes |
| `hentaifox` | [](https://github.com/sinkaroid/tomoe/actions/workflows/hentaifox.yml) | `Yes` | ~0.33 minutes |
| `hentai2read` | [](https://github.com/sinkaroid/tomoe/actions/workflows/hentai2read.yml) | `Yes` | ~0.10 minutes |
| `simply-hentai` | [](https://github.com/sinkaroid/tomoe/actions/workflows/simply.yml) | `Yes` | ~0.29 minutes |
| `asmhentai` | [](https://github.com/sinkaroid/tomoe/actions/workflows/asmhentai.yml) | `Yes` | ~0.23 minutes |
| `3hentai` | [](https://github.com/sinkaroid/tomoe/actions/workflows/3hentai.yml) | `Yes` | ~0.20 minutes |
## Features
- Plenty of sites coverage
- Built-in auto render into PDF
- Modular bulk download
- Minimalist dependencies
- Download with ease, doesn't require you a lot of arguments
## Site support
Currently tomoe supports the following websites:
- [nhentai.net](https://nhentai.net/)
- [pururin.to](https://pururin.to/)
- [hentaifox.com](https://hentaifox.com/)
- [hentai2read.com](https://hentai2read.com/)
- [simply-hentai.com](https://simply-hentai.com/)
- [asmhentai.com](https://asmhentai.com/)
- [3hentai.net](https://3hentai.net/)
## Prerequisites
NOTE: Python 3.7 or above
## Installation
`pip install tomoe`
- Or manual build by cloning the repository and run `python setup.py install`
## Command usage
> `tomoe --args `
## Quick example
> `tomoe --nhentai 177013`
After that, you could see the download results or throw you an error if something went wrong.
## Options
It's fairly simple to use tomoe
| **Argument** | **Description** | **Example** |
| --------------------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--nhentai`, int | nhentai | [`tomoe --nhentai 255369`](https://nhentai.net/g/255369/) |
| `--pururin`, int | pururin | [`tomoe --pururin 47226`](https://pururin.to/gallery/47226/crot-sampe-lumpuh) |
| `--hentaifox`, int | hentaifox | [`tomoe --hentaifox 59026`](https://hentaifox.com/gallery/59026/) |
| `--hentai2read`, str | hentai2read | [`tomoe --hentai2read chaldea_life/1`](https://hentai2read.com/chaldea_life/) |
| `--simply`, str | simply-hentai | [`tomoe --simply "fate-grand-order/fgo-no-ashibon-fgo-foot-book/all-pages"`](https://www.simply-hentai.com/fate-grand-order/fgo-no-ashibon-fgo-foot-book/all-pages) |
| `--asmhentai`, int | asmhentai | [`tomoe --asmhentai 311851`](https://asmhentai.com/g/311851/)
| `--three`, int | 3hentai | [`tomoe --three 608979`](https://asmhentai.com/g/311851/) |
| `--bulk`, str | custom bulk download | [`tomoe --bulk doujin.json`](/doujin.json) |
| `--pdf`, str | render pdf for each title | [`tomoe --nhentai 255369 --pdf`](https://3hentai.net/d/608979) |
## Bulk download
You can pass multiple id to request bulk download
| **Sites** | **Description** | **Example** |
| ----------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| nhentai | place multiple id | `tomoe --nhentai 255369 417103 417119` |
| pururin | place multiple id | `tomoe --pururin 47226 64351 56175` |
| hentaifox | place multiple id | `tomoe --hentaifox 59026 61805` |
| hentai2read | place multiple path | `tomoe --hentai2read chaldea_life/1 watashitachi_producersan_ni_mechakucha/1` |
| simply | place multiple chapter | `tomoe --simply "fate-grand-order/fgo-no-ashibon-fgo-foot-book/all-pages" "original-work/kanchou-manga-cffc37a/all-pages"` |
| asmhentai | place multiple id | `tomoe --asmhentai 311851 210135 309068` |
## Bulk download using nested list
> `tomoe --bulk doujin.json`
If you need to download multiple doujins from each different website, you can do a bulk download using an arbitrary method. Meaning that you can mix and wrap the whole book ids into nested array in a JSON file. Read more about [Understanding Nested Arrays.](https://javascript.plainenglish.io/understanding-the-nested-arrays-fbf3ab13c2b4#:~:text=An%20array%20is%20an%20ordered,the%20element%20of%20an%20array)
Create `doujin.json` in the same directory where you want to run tomoe and follow this structure:
**Note** _You should not change the "book" property_
```js
{
"book": [
{
"nhentai": 177013
},
{
"nhentai": 255369
},
{
"pururin": 47226
},
{
"pururin": 64351
},
{
"hentaifox": 59026
},
{
"hentaifox": 61805
},
{
"asmhentai": 311851
},
{
"asmhentai": 210135
},
{
"hentai2read": "chaldea_life/1"
},
{
"simply": "fate-grand-order/fgo-no-ashibon-fgo-foot-book/all-pages"
}
]
}
```
Then tell tomoe to resolve all the book ids from the JSON file.
`tomoe --bulk doujin.json`
## Pronunciation
[`ja_JP`](https://www.localeplanet.com/java/ja-JP/index.html) • **to-moe** — commonly translated as "comma", is a comma-like swirl symbol used in Japanese mon. It closely resembles the usual form of a magatama.
## Legal
This tool can be freely copied, modified, altered, distributed without any attribution whatsoever. However, if you feel
like this tool deserves an attribution, mention it. It won't hurt anybody.
> Licence: WTF.