-nhentai\r
-=======\r
-\r
-.. code-block::\r
-\r
- _ _ _ _\r
- _ __ | | | | ___ _ __ | |_ __ _(_)\r
- | '_ \| |_| |/ _ \ '_ \| __/ _` | |\r
- | | | | _ | __/ | | | || (_| | |\r
- |_| |_|_| |_|\___|_| |_|\__\__,_|_|\r
-\r
-\r
-あなたも変態。 いいね? \r
-|travis|\r
-|pypi|\r
-|license|\r
-\r
-\r
-nHentai is a CLI tool for downloading doujinshi from <http://nhentai.net>\r
-\r
-============\r
-Installation\r
-============\r
-.. code-block::\r
-\r
- git clone https://github.com/RicterZ/nhentai\r
- cd nhentai\r
- python setup.py install\r
- \r
-=====================\r
-Installation (Gentoo)\r
-=====================\r
-.. code-block::\r
-\r
- layman -fa glicOne\r
- sudo emerge net-misc/nhentai\r
-\r
-=====\r
-Usage\r
-=====\r
-**IMPORTANT**: To bypass the nhentai frequency limit, you should use `--cookie` option to store your cookie.\r
-*The default download folder will be the path where you run the command (CLI path).*\r
-\r
-\r
-Set your nhentai cookie against captcha:\r
-\r
-.. code-block:: bash\r
-\r
- nhentai --cookie 'YOUR COOKIE FROM nhentai.net'\r
-\r
-Download specified doujinshi:\r
-\r
-.. code-block:: bash\r
-\r
- nhentai --id=123855,123866\r
-\r
-Download doujinshi with ids specified in a file (doujinshi ids split by line):\r
-\r
-.. code-block:: bash\r
-\r
- nhentai --file=doujinshi.txt\r
-\r
-Search a keyword and download the first page:\r
-\r
-.. code-block:: bash\r
-\r
- nhentai --search="tomori" --page=1 --download\r
-\r
-Download by tag name:\r
-\r
-.. code-block:: bash\r
-\r
- nhentai --tag lolicon --download --page=2\r
-\r
-Download your favorites with delay:\r
-\r
-.. code-block:: bash\r
-\r
- nhentai --favorites --download --delay 1\r
-\r
-=======\r
-Options\r
-=======\r
-+ `-t, --thread`: Download threads, max: 10 \r
-+ `--output`:Output dir of saving doujinshi \r
-+ `--tag`:Download by tag name \r
-+ `--timeout`: Timeout of downloading each image \r
-+ `--proxy`: Use proxy, example: http://127.0.0.1:8080/ \r
-+ `--login`: username:password pair of your nhentai account \r
-+ `--nohtml`: Do not generate HTML \r
-+ `--cbz`: Generate Comic Book CBZ File \r
-\r
-==============\r
-nHentai Mirror\r
-==============\r
-If you want to use a mirror, you should set up a reverse proxy of `nhentai.net` and `i.nhentai.net`.\r
-For example:\r
-\r
-.. code-block:: \r
-\r
- i.h.loli.club -> i.nhentai.net\r
- h.loli.club -> nhentai.net\r
-\r
-Set `NHENTAI` env var to your nhentai mirror.\r
-\r
-.. code-block:: bash\r
-\r
- NHENTAI=http://h.loli.club nhentai --id 123456\r
-\r
-\r
-.. image:: ./images/search.png?raw=true\r
- :alt: nhentai\r
- :align: center\r
-.. image:: ./images/download.png?raw=true\r
- :alt: nhentai\r
- :align: center\r
-.. image:: ./images/viewer.png?raw=true\r
- :alt: nhentai\r
- :align: center\r
-\r
-============\r
-あなたも変態\r
-============\r
-.. image:: ./images/image.jpg?raw=true\r
- :alt: nhentai\r
- :align: center\r
-\r
-\r
-\r
-.. |travis| image:: https://travis-ci.org/RicterZ/nhentai.svg?branch=master\r
- :target: https://travis-ci.org/RicterZ/nhentai\r
-\r
-.. |pypi| image:: https://img.shields.io/pypi/dm/nhentai.svg\r
- :target: https://pypi.org/project/nhentai/\r
-\r
-.. |license| image:: https://img.shields.io/github/license/ricterz/nhentai.svg\r
- :target: https://github.com/RicterZ/nhentai/blob/master/LICENSE\r
+nhentai
+=======
+
+.. code-block::
+
+ _ _ _ _
+ _ __ | | | | ___ _ __ | |_ __ _(_)
+ | '_ \| |_| |/ _ \ '_ \| __/ _` | |
+ | | | | _ | __/ | | | || (_| | |
+ |_| |_|_| |_|\___|_| |_|\__\__,_|_|
+
+
+あなたも変態。 いいね?
+
+|travis|
+|pypi|
+|license|
+
+
+nHentai is a CLI tool for downloading doujinshi from <http://nhentai.net>
+
+===================
+Manual Installation
+===================
+.. code-block::
+
+ git clone https://github.com/RicterZ/nhentai
+ cd nhentai
+ python setup.py install
+
+==================
+Installation (pip)
+==================
+Alternatively, install from PyPI with pip:
+
+.. code-block::
+
+ pip install nhentai
+
+For a self-contained installation, use `Pipx <https://github.com/pipxproject/pipx/>`_:
+
+.. code-block::
+
+ pipx install nhentai
+
+=====================
+Installation (Gentoo)
+=====================
+.. code-block::
+
+ layman -fa glicOne
+ sudo emerge net-misc/nhentai
+
+=====================
+Installation (NixOs)
+=====================
+.. code-block::
+
+ nix-env -iA nixos.nhentai
+
+=====
+Usage
+=====
+**IMPORTANT**: To bypass the nhentai frequency limit, you should use `--cookie` option to store your cookie.
+
+*The default download folder will be the path where you run the command (CLI path).*
+
+
+Set your nhentai cookie against captcha:
+
+.. code-block:: bash
+
+ nhentai --cookie "YOUR COOKIE FROM nhentai.net"
+
+**NOTE**
+
+- The format of the cookie is `"csrftoken=TOKEN; sessionid=ID; cf_clearance=CLOUDFLARE"`
+- `cf_clearance` cookie and useragent must be set if you encounter "blocked by cloudflare captcha" error. Make sure you use the same IP and useragent as when you got it
+
+| To get csrftoken and sessionid, first login to your nhentai account in web browser, then:
+| (Chrome) |ve| |ld| More tools |ld| Developer tools |ld| Application |ld| Storage |ld| Cookies |ld| https://nhentai.net
+| (Firefox) |hv| |ld| Web Developer |ld| Web Developer Tools |ld| Storage |ld| Cookies |ld| https://nhentai.net
+|
+
+.. |hv| unicode:: U+2630 .. https://www.compart.com/en/unicode/U+2630
+.. |ve| unicode:: U+22EE .. https://www.compart.com/en/unicode/U+22EE
+.. |ld| unicode:: U+2014 .. https://www.compart.com/en/unicode/U+2014
+
+Download specified doujinshi:
+
+.. code-block:: bash
+
+ nhentai --id=123855,123866
+
+Download doujinshi with ids specified in a file (doujinshi ids split by line):
+
+.. code-block:: bash
+
+ nhentai --file=doujinshi.txt
+
+Set search default language
+
+.. code-block:: bash
+
+ nhentai --language=english
+
+Search a keyword and download the first page:
+
+.. code-block:: bash
+
+ nhentai --search="tomori" --page=1 --download
+ # you also can download by tags and multiple keywords
+ nhentai --search="tag:lolicon, artist:henreader, tag:full color"
+ nhentai --search="lolicon, henreader, full color"
+
+Download your favorites with delay:
+
+.. code-block:: bash
+
+ nhentai --favorites --download --delay 1
+
+Format output doujinshi folder name:
+
+.. code-block:: bash
+
+ nhentai --id 261100 --format '[%i]%s'
+
+Supported doujinshi folder formatter:
+
+- %i: Doujinshi id
+- %t: Doujinshi name
+- %s: Doujinshi subtitle (translated name)
+- %a: Doujinshi authors' name
+- %p: Doujinshi pretty name
+
+
+Other options:
+
+.. code-block::
+
+ Usage:
+ nhentai --search [keyword] --download
+ NHENTAI=http://h.loli.club nhentai --id [ID ...]
+ nhentai --file [filename]
+
+ Environment Variable:
+ NHENTAI nhentai mirror url
+
+ Options:
+ # Operation options, control the program behaviors
+ -h, --help show this help message and exit
+ -D, --download download doujinshi (for search results)
+ -S, --show just show the doujinshi information
+
+ # Doujinshi options, specify id, keyword, etc.
+ --id=ID doujinshi ids set, e.g. 1,2,3
+ -s KEYWORD, --search=KEYWORD
+ search doujinshi by keyword
+ -F, --favorites list or download your favorites.
+
+ # Page options, control the page to fetch / download
+ --page-all all search results
+ --page=PAGE, --page-range=PAGE
+ page number of search results. e.g. 1,2-5,14
+ --sorting=SORTING sorting of doujinshi (recent / popular /
+ popular-[today|week])
+
+ # Download options, the output directory, threads, timeout, delay, etc.
+ -o OUTPUT_DIR, --output=OUTPUT_DIR
+ output dir
+ -t THREADS, --threads=THREADS
+ thread count for downloading doujinshi
+ -T TIMEOUT, --timeout=TIMEOUT
+ timeout for downloading doujinshi
+ -d DELAY, --delay=DELAY
+ slow down between downloading every doujinshi
+ --proxy=PROXY store a proxy, for example: -p 'http://127.0.0.1:1080'
+ -f FILE, --file=FILE read gallery IDs from file.
+ --format=NAME_FORMAT format the saved folder name
+ -r, --dry-run Dry run, skip file download.
+
+ # Generate options, for generate html viewer, cbz file, pdf file, etc
+ --html generate a html viewer at current directory
+ --no-html don't generate HTML after downloading
+ --gen-main generate a main viewer contain all the doujin in the
+ folder
+ -C, --cbz generate Comic Book CBZ File
+ -P, --pdf generate PDF file
+ --rm-origin-dir remove downloaded doujinshi dir when generated CBZ or
+ PDF file.
+ --meta generate a metadata file in doujinshi format
+ --regenerate-cbz regenerate the cbz file if exists
+
+ # nhentai options, set cookie, user-agent, language, remove caches, histories, etc
+ --cookie=COOKIE set cookie of nhentai to bypass Cloudflare captcha
+ --useragent=USERAGENT
+ set useragent to bypass Cloudflare captcha
+ --language=LANGUAGE set default language to parse doujinshis
+ --clean-language set DEFAULT as language to parse doujinshis
+ --save-download-history
+ save downloaded doujinshis, whose will be skipped if
+ you re-download them
+ --clean-download-history
+ clean download history
+ --template=VIEWER_TEMPLATE
+ set viewer template
+
+==============
+nHentai Mirror
+==============
+If you want to use a mirror, you should set up a reverse proxy of `nhentai.net` and `i.nhentai.net`.
+For example:
+
+.. code-block::
+
+ i.h.loli.club -> i.nhentai.net
+ h.loli.club -> nhentai.net
+
+Set `NHENTAI` env var to your nhentai mirror.
+
+.. code-block:: bash
+
+ NHENTAI=http://h.loli.club nhentai --id 123456
+
+
+.. image:: ./images/search.png?raw=true
+ :alt: nhentai
+ :align: center
+.. image:: ./images/download.png?raw=true
+ :alt: nhentai
+ :align: center
+.. image:: ./images/viewer.png?raw=true
+ :alt: nhentai
+ :align: center
+
+
+
+.. |travis| image:: https://travis-ci.org/RicterZ/nhentai.svg?branch=master
+ :target: https://travis-ci.org/RicterZ/nhentai
+
+.. |pypi| image:: https://img.shields.io/pypi/dm/nhentai.svg
+ :target: https://pypi.org/project/nhentai/
+
+.. |license| image:: https://img.shields.io/github/license/ricterz/nhentai.svg
+ :target: https://github.com/RicterZ/nhentai/blob/master/LICENSE
projects / nhentai.git / blobdiff