hentai-chan / hentai Goto Github PK

View Code? Open in Web Editor NEW

208.0 10.0 19.0 2.95 MB

Implements a wrapper class around nhentai's RESTful API.

Home Page: https://www.hentai-chan.dev/projects/hentai

License: GNU General Public License v3.0

Python 100.00%

hentai nhentai nhentai-api python wrapper hacktoberfest

hentai's Introduction

“De gustibus non est disputandum.”

Python Hentai API Wrapper

English | 简体中文

This python package implements a wrapper class around nhentai's RESTful API. Please be aware that this is not an official API, technical questions about nhentai.net should be redirected to [email protected]. Further note that the content of this module is generally considered NSFW. Finally, I would like to comment at this point that you should under no circumstances use this module to make an unreasonable amount of requests in a short period of time.

Installation

Get the most recent stable release from PyPI:

pip install hentai --only-binary all

Dev Notes for Contributors

Alternatively, if you're looking to make a contribution fork this repository and run

python -m venv venv/
source venv/bin/activate # For Windows: .\venv\Scripts\activate
python -m pip install --upgrade pip
pip install -r requirements/dev.txt
# additionally install the following dependencies
pip install flake8 pytest wheel
# run all unit tests
pytest --verbose -s
# create wheel
python setup.py bdist_wheel --universal

Make sure to checkout rec-hentai so that your work is up-to-date with the next release candidate. Don't implement any features that are incompatible with version 3.7+ of python.

Documentation

You can find the documentation online, or use the wiki to learn more about this module.

Basic Usage

Hentai makes it very easy to browse through nhentai.net. It implements a flat namespace for easy access of all their endpoints:

from hentai import Hentai, Format

doujin = Hentai(177013)

# True
Hentai.exists(doujin.id)

# METAMORPHOSIS
print(doujin.title(Format.Pretty))

# [Tag(id=3981, type='artist', name='shindol', url='https://nhentai.net/artist/shindol/', count=279)]
print(doujin.artist)

# ['dark skin', 'group', ... ]
print([tag.name for tag in doujin.tag])

# 2016-10-18 12:28:49+00:00
print(doujin.upload_date)

# ['https://i.nhentai.net/galleries/987560/1.jpg', ... ]
print(doujin.image_urls)

# get the source
doujin.download(progressbar=True)

Apart from that, hentai.Utils also provides a handful of miscellaneous helper methods:

from hentai import Utils, Sort, Option, Tag
from pathlib import Path

print(Utils.get_random_id())

# recommend me something good!
print(Utils.get_random_hentai())

# advanced search with queries
for doujin in Utils.search_by_query('tag:loli', sort=Sort.PopularWeek):
    print(doujin.title(Format.Pretty))

# print all character names from all doujins
for character in Tag.list(Option.Character):
    print(character.name)

# store custom meta data as JSON file to disk
popular_loli = Utils.search_by_query('tag:loli', sort=Sort.PopularWeek)
custom = [Option.ID, Option.Title, Option.Epos]
Utils.export(popular_loli, filename=Path('popular_loli.json'), options=custom)

See also https://nhentai.net/info/ for more information on search queries.

Command Line Interface

Starting with version 3.2.4, this module also provides a rudimentary CLI for downloading doujins within the terminal:

# get help
hentai --help

# download this doujin to the CWD
hentai download --id 177013

# check the module version
hentai --version

Get In Touch

You can reach me at [email protected] for private questions and inquires that don't belong to the issue tab.

hentai's People

Contributors

Stargazers

Watchers

Forkers

mousesama amartyadebnath poisongut fossabot kiranajij ueefi powerplayer75 zazzhanks rockin79 gianghia123 ttdyce stoozey nekaru-storage lovrman96 krishsharma0413 infinity-blackmirror zyxdevs daftanime

hentai's Issues

[ BUG ] Error while trying to interact with the wrapper/api

Describe the Bug

I'm using version 3.2.10 and get an error while trying to interact with the api in any form.

Steps To Reproduce

Any interaction is failing which makes me think it's an API change or something.

`from hentai import Hentai as H

print(H(177013))`

System Information

| OS Name | Python Version | App Version |
|:----------:|:----------:|:--------------:|:-----------:|
| Windows | 3.10.2 | 3.2.10 |

Error message & warnings

Traceback (most recent call last):
  File "C:\Users\imagi\AppData\Local\Programs\Python\Python310\lib\site-packages\requests\adapters.py", line 440, in send
    resp = conn.urlopen(
  File "C:\Users\imagi\AppData\Local\Programs\Python\Python310\lib\site-packages\urllib3\connectionpool.py", line 876, in urlopen
    return self.urlopen(
  File "C:\Users\imagi\AppData\Local\Programs\Python\Python310\lib\site-packages\urllib3\connectionpool.py", line 876, in urlopen
    return self.urlopen(
  File "C:\Users\imagi\AppData\Local\Programs\Python\Python310\lib\site-packages\urllib3\connectionpool.py", line 876, in urlopen
    return self.urlopen(
  [Previous line repeated 2 more times]
  File "C:\Users\imagi\AppData\Local\Programs\Python\Python310\lib\site-packages\urllib3\connectionpool.py", line 866, in urlopen
    retries = retries.increment(method, url, response=response, _pool=self)
  File "C:\Users\imagi\AppData\Local\Programs\Python\Python310\lib\site-packages\urllib3\util\retry.py", line 592, in increment
    raise MaxRetryError(_pool, url, error or ResponseError(cause))
urllib3.exceptions.MaxRetryError: HTTPSConnectionPool(host='nhentai.net', port=443): Max retries exceeded with url: /api/gallery/177013 (Caused by ResponseError('too many 503 error responses'))

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "D:\Projects\discordbot\test.py", line 3, in <module>
    print(H(177013))
  File "C:\Users\imagi\AppData\Local\Programs\Python\Python310\lib\site-packages\hentai\hentai.py", line 531, in __init__
    self.__response = self.handler.get(self.api)
  File "C:\Users\imagi\AppData\Local\Programs\Python\Python310\lib\site-packages\hentai\hentai.py", line 479, in get
    response = self.session.get(url, timeout=self.timeout, proxies=self.proxies or getproxies(), **kwargs)
  File "C:\Users\imagi\AppData\Local\Programs\Python\Python310\lib\site-packages\requests\sessions.py", line 542, in get
    return self.request('GET', url, **kwargs)
  File "C:\Users\imagi\AppData\Local\Programs\Python\Python310\lib\site-packages\requests\sessions.py", line 529, in request
    resp = self.send(prep, **send_kwargs)
  File "C:\Users\imagi\AppData\Local\Programs\Python\Python310\lib\site-packages\requests\sessions.py", line 645, in send
    r = adapter.send(request, **kwargs)
  File "C:\Users\imagi\AppData\Local\Programs\Python\Python310\lib\site-packages\requests\adapters.py", line 510, in send
    raise RetryError(e, request=request)
requests.exceptions.RetryError: HTTPSConnectionPool(host='nhentai.net', port=443): Max retries exceeded with url: /api/gallery/177013 (Caused by ResponseError('too many 503 error responses'))```

### Code samples

```cli
from hentai import Hentai as H

print(H(177013))

Expected behavior

I'm expecting it to return a Hentai object.

[ BUG ] AttributeError: 'PosixPath' object has no attribute 'startswith'

Describe the Bug

This error occured when I update my python and importing Hentai

Steps To Reproduce

When I try to run

from hentai import Hentai

The error occured

System Information

OS Name	Build No.	Python Version	App Version
`Arch Linux`	`5.10.30-1-lts`	`3.9.5`	``

Error message & warnings

```bash
Traceback (most recent call last):
  File "/usr/lib/python3.9/pkgutil.py", line 416, in get_importer
    importer = sys.path_importer_cache[path_item]
KeyError: PosixPath('/home/lordronz/.local/lib/python3.9/site-packages/faker/providers')

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/lordronz/.local/lib/python3.9/site-packages/hentai/__init__.py", line 5, in <module>
    from .hentai import *
  File "/home/lordronz/.local/lib/python3.9/site-packages/hentai/hentai.py", line 45, in <module>
    from faker import Faker
  File "/home/lordronz/.local/lib/python3.9/site-packages/faker/__init__.py", line 1, in <module>
    from faker.factory import Factory
  File "/home/lordronz/.local/lib/python3.9/site-packages/faker/factory.py", line 7, in <module>
    from faker.config import AVAILABLE_LOCALES, DEFAULT_LOCALE, PROVIDERS
  File "/home/lordronz/.local/lib/python3.9/site-packages/faker/config.py", line 11, in <module>
    PROVIDERS = find_available_providers(
  File "/home/lordronz/.local/lib/python3.9/site-packages/faker/utils/loading.py", line 57, in find_available_providers
    for mod in list_module(providers_mod) if mod != '__pycache__'
  File "/home/lordronz/.local/lib/python3.9/site-packages/faker/utils/loading.py", line 35, in list_module
    return [name for _, name, is_pkg in pkgutil.iter_modules([path]) if is_pkg]
  File "/home/lordronz/.local/lib/python3.9/site-packages/faker/utils/loading.py", line 35, in <listcomp>
    return [name for _, name, is_pkg in pkgutil.iter_modules([path]) if is_pkg]
  File "/usr/lib/python3.9/pkgutil.py", line 130, in iter_modules
    for i in importers:
  File "/usr/lib/python3.9/pkgutil.py", line 420, in get_importer
    importer = path_hook(path_item)
  File "<frozen importlib._bootstrap_external>", line 1601, in path_hook_for_FileFinder
  File "<frozen importlib._bootstrap_external>", line 1476, in __init__
  File "<frozen importlib._bootstrap_external>", line 177, in _path_isabs
AttributeError: 'PosixPath' object has no attribute 'startswith'

Code samples

from hentai import Hentai

Expected behavior

Successfully imported

Additional context

None

[ ENH ] A function to fetch the popular_now section

Utils.get_homepage currently doesn't fetch the Popular Now section, as It should. So I was thinking fo making a new function in Utils to fetch the current trending Doujins.

I am not actually familiar with the json requests I need to make in order to fetch so currently I don't have any code that does the job but if anyone knows, you can comment the format and I'll implement the function

error when trying to access nhentai.net

I got this error everytime I try to use any function of the api:

requests.exceptions.ConnectionError:` HTTPSConnectionPool(host='nhentai.net', port=443): Max retries exceeded with url: /api/gallery/123456789 (Caused by ReadTimeoutError("HTTPSConnectionPool(host='nhentai.net', port=443): Read timed out. (read timeout=5)"))

I don't have any idea to fix it

im using:

manjaro linux,
hentai 3.2.4 (to avoid this problem),
python 3.9.1

I don't think it's a bug, so i did not used the template to make this issue ^^

Module do not work anymore

I got a error like this when try to execute a code

Exception has occurred: RetryError
HTTPSConnectionPool(host='nhentai.net', port=443): Max retries exceeded with url: /random (Caused by ResponseError('too many 503 error responses'))

This is my code

from hentai import Hentai, Format

doujin = Hentai(177013)
print(doujin.url)

[ ENH ] Add Export Function

Issue Description

Is your feature request related to a problem? Please describe.
Implement a function that stores data as a JSON file to disk for processing in other languages.

Describe the solution you'd like

from hentai import Hentai

popular_loli = Hentai.search_all_by_query('tag:loli')

# dest should default to CWD
# keyword arguments narrow down the properties to store 
# Hentai.All should save all properties bound to a Hentai object
Hentai.export(popular_loli, dest='./target/path/filename.json', options=[Hentai.ID, Hentai.UploadDate])

This function should also work with collections coming from

search_by_query
get_homepage
browse_homepage
any Hentai object

Describe alternatives you've considered
If there is an easier way to specify which properties to include (like Hentai.ID, etc.), go for it. Either way, this function should be able to to influence the result of the outcome in order to reduce the final file size, but also to make it easier to inspect the data later on by dismissing unnecessary information upfront.

Sample Input

Example 1

>>> from hentai import Hentai
>>> doujin = Hentai(177013)
>>> # save doujin.json to disk
>>> doujin.export()

Example 2

>>> from hentai import Hentai
>>> doujin = Hentai(177013)
>>> # save doujin.json to disk
>>> doujin.export(options=[Hentai.ID, Hentai.UploadDate, Hentai.NumFavorites])

Sample Output

Example 1

{'id': 177013, 'media_id': '987560', 'title': {'english': '[ShindoLA] METAMORPHOSIS (Complete) [English]', ...

Example 2

{'id': 177013, 'upload_date': '2016-10-18 14:28:49', 'num_favorites': 44548}

Lists of doujins coming from search_by_query or get_homepage should export the information using the same format wrapped around a list, e.g.

doujins = Hentai.get_homepage()
Hentai.export(doujins, options=[Hentai.ID, Hentai.UploadDate, Hentai.NumFavorites])

[
  {
    'id': 177013,
    'upload_date': "2016-10-18 14:28:49",
    'num_favorites': 44548
  },
  {
    'id': 269582,
    'upload_date': "2019-04-20 14:54:07",
    'num_favorites': 6163
  },
  ...
]

Additional context
See also the current contributing guidelines and the project's wiki. Don't forget to add a unit test to the test suite at hentai/test_hentai once everything is said and done.

Library not working due to poor request

Describe the Bug

Getting the 'too many 503 error responses' error when calling the package

Steps To Reproduce

from hentai import Hentai

doujin = Hentai(177013)
print(Hentai.exists(doujin.id))

System Information

| OS Name | Python Version | App Version |
|:---------- --:|:-----------------:|:-----------:|
| Windows | 3.10.2 | 3.2.10 |

Error message & warnings

Traceback (most recent call last):
  File "C:\Python310\lib\site-packages\requests\adapters.py", line 440, in send
    resp = conn.urlopen(
  File "C:\Python310\lib\site-packages\urllib3\connectionpool.py", line 876, in urlopen
    return self.urlopen(
  File "C:\Python310\lib\site-packages\urllib3\connectionpool.py", line 876, in urlopen
    return self.urlopen(
  File "C:\Python310\lib\site-packages\urllib3\connectionpool.py", line 876, in urlopen
    return self.urlopen(
  [Previous line repeated 2 more times]
  File "C:\Python310\lib\site-packages\urllib3\connectionpool.py", line 866, in urlopen
    retries = retries.increment(method, url, response=response, _pool=self)
  File "C:\Python310\lib\site-packages\urllib3\util\retry.py", line 592, in increment
    raise MaxRetryError(_pool, url, error or ResponseError(cause))
urllib3.exceptions.MaxRetryError: HTTPSConnectionPool(host='nhentai.net', port=443): Max retries exceeded with url: /api/gallery/177013 (Caused by ResponseError('too many 503 error responses'))

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "C:\Users\xxx\Desktop\hentai scrping\hentai\test.py", line 3, in <module>
    doujin = Hentai(177013)
  File "C:\Python310\lib\site-packages\hentai\hentai.py", line 531, in __init__
    self.__response = self.handler.get(self.api)
  File "C:\Python310\lib\site-packages\hentai\hentai.py", line 479, in get
    response = self.session.get(url, timeout=self.timeout, proxies=self.proxies or getproxies(), **kwargs)
  File "C:\Python310\lib\site-packages\requests\sessions.py", line 542, in get
    return self.request('GET', url, **kwargs)
  File "C:\Python310\lib\site-packages\requests\sessions.py", line 529, in request
    resp = self.send(prep, **send_kwargs)
  File "C:\Python310\lib\site-packages\requests\sessions.py", line 645, in send
    r = adapter.send(request, **kwargs)
  File "C:\Python310\lib\site-packages\requests\adapters.py", line 510, in send
    raise RetryError(e, request=request)
requests.exceptions.RetryError: HTTPSConnectionPool(host='nhentai.net', port=443): Max retries exceeded with url: /api/gallery/177013 (Caused by ResponseError('too many 503 error responses'))

Additional context

I know that we all have a hard time scraping nhentai due to Cloudflare. Just wondering if there is a good solution now? Also is there any instruction on how to set up OAuth2 with this package?

[ BUG ] Make Request Paramter Not Working

Describe the bug
The make_request paramter doesn't work if the CWD isn't set to the package's root directory.

To Reproduce
Steps to reproduce the behavior:

Install package with pip install hentai
Error message:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "C:\Users\hentai-chan\AppData\Roaming\Python\Python38\site-packages\hentai\hentai.py", line 630, in get_random_id
    with open("./data/ids.csv", mode='r', encoding='utf-8') as file_handler:
FileNotFoundError: [Errno 2] No such file or directory: './data/ids.csv'

Code samples

>>> from hentai import Utils
>>> Utils.get_random_id(make_request=False)

Additional context
Useful links that help you fix that error:
[1] Python Docs on importlib.resources
[2] Read the Docs for importlib_resources

The project's file system layout needs to adapt to these changes without breaking backwards compatibility. As laid down in commit c7046e0, this is just an experimental feature so this bug fix is a low priority on my bucket list. For anyone else interested in fixing this issue, feel free to have a shot at it!

[ ENH ] Python 3.7 Support

Is your feature request related to a problem? Please describe.
As you detailed in this issue, a reason for a lack of Python 3.6 support was the implementation of dataclasses. I followed up with PyPy now supporting 3.7 and now support dataclasses.

I did a test and yes, dataclasses are supported.

Python 3.7.4 (87875bf2dfd8, Sep 24 2020, 07:27:16)
[PyPy 7.3.2-alpha0 with MSC v.1927 32 bit] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>>> import hentai
>>>> doujin = hentai.Hentai(177013)
>>>> print(doujin.tags[0])
Tag(id=19018, type='tag', name='dark skin', url='/tag/dark-skin/', count=21056)
>>>> doujin.tags[0].id
19018
>>>> type(doujin.tags[0])
<class 'hentai.hentai.Tag'>

Describe the solution you'd like
As Python 3.7 has dataclasses inbuilt, there is no need for a backport of dataclasses and supporting Python 3.7 would only require the following patch:

-     assert sys.version_info.minor > 7
+     assert sys.version_info.minor >= 7
-     raise RuntimeError("Hentai requires Python 3.8+!") 
+     raise RuntimeError("Hentai requires Python 3.7+!")

[ ENH & TST ] Rewrite test suite from scratch

Is your feature request related to a problem? Please describe.
As it stands now, the unit test only check if the test file's meta data are in sync with https://nhentai.net.

Describe the solution you'd like
Rewrite everything using patch from unittest.mock this time.

Describe alternatives you've considered

Additional context
See also: unittest.mock

[ ENH ] customizing log path

Is your feature request related to a problem? Please describe

The problem happens when I try to use the library in a system that does not have write permission to /var/log
the issue happens when assigning the file handler for logger

Describe the solution you'd like

Add the ability to change the logging file location or disable logging completely

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

[ ENH ] User Agent

Is your feature request related to a problem? Please describe.
At the moment, this library uses the same user agent over and over again. I recenlty ran into an interesting article that showcase how to fake and rotate between multiple user agents.

Describe the solution you'd like
See the aforementioned article.

Describe alternatives you've considered
I also saw some interesting libraries that look very promising on GitHub. Maybe we can put off some work on a third-party dependency? If the proposed library is well-maintained and offers a good solution, I would be willing to take this approach into consideration as well.

Additional context
See also the current contributing guidelines and the project's wiki. Don't forget to add a unit test to the test suite at hentai/tests/ once everything is said and done.

[ DOC ] Online Documentation

This is a WIP that is being developed on a private repository. The website will be hosted by pythonanywhere at

https://hentaichan.pythonanywhere.com/projects/hentai

While the website is under construction, it remains inaccessible to the general public.

Hentai.exists

I'm not sure but the Hentai.exists method doesn't seem to return false

hentai-chan / hentai Goto Github PK

hentai's Introduction

Python Hentai API Wrapper

Installation

Documentation

Basic Usage

Command Line Interface

Get In Touch

hentai's People

Contributors

Stargazers

Watchers

Forkers

hentai's Issues

Describe the Bug

Steps To Reproduce

System Information

Error message & warnings

Expected behavior

Describe the Bug

This error occured when I update my python and importing Hentai

Steps To Reproduce

System Information

Error message & warnings

Code samples

Expected behavior

Additional context

Issue Description

Sample Input

Sample Output

Describe the Bug

Getting the 'too many 503 error responses' error when calling the package

Steps To Reproduce

System Information

Error message & warnings

Additional context

Is your feature request related to a problem? Please describe

Describe the solution you'd like

Describe alternatives you've considered

Additional context

Recommend Projects

Recommend Topics

Recommend Org