NopeCHA
![Mozilla Add-on Version](https://img.shields.io/amo/v/noptcha?label=Mozilla%20Add-on&color=4a4&link=https%3A%2F%2Fnopecha.com&link=https%3A%2F%2Fnopecha.com%2Ffirefox)
API bindings for the NopeCHA CAPTCHA service.
Installation
To install from PyPI, run python3 -m pip install nopecha
.
API Usage
This package provides API wrappers for the following http packages:
Note: You will need to install the http package you want to use separately
(except for urllib
, as it's built-in but not recommended).
Requests example
from nopecha.api.requests import RequestsAPIClient
api = RequestsAPIClient("YOUR_API_KEY")
solution = api.solve_hcaptcha("b4c45857-0e23-48e6-9017-e28fff99ffb2", "https://nopecha.com/demo/hcaptcha#easy")
print("token is", solution["data"])
Async HTTPX example
from nopecha.api.httpx import AsyncHTTPXAPIClient
async def main():
api = AsyncHTTPXAPIClient("YOUR_API_KEY")
solution = await api.solve_hcaptcha("b4c45857-0e23-48e6-9017-e28fff99ffb2", "https://nopecha.com/demo/hcaptcha#easy")
print("token is", solution["data"])
asyncio.run(main())
Extension builder
This package also provides a extension builder for
Automation builds
which includes:
- downloading the extension
- updating the extension
- updating the extension's manifest to include your settings
Example
from nopecha.extension import build_chromium
output = build_chromium({
"key": "YOUR_API_KEY",
})
from pathlib import Path
output = build_chromium({
"key": "YOUR_API_KEY",
}, Path("extension"))
You can plug the output path directly into your browser's extension manager to
load the extension:
import undetected_chromedriver as uc
from nopecha.extension import build_chromium
output = build_chromium({
"key": "YOUR_API_KEY",
})
options = uc.ChromeOptions()
options.add_argument(f"load-extension={output}")
Building
To build from source, you will need to install
build
(python3 -m pip install --upgrade build
).
Then simply run python3 -m build
to build the package.
Uploading to PyPI
To upload to PyPI, you will need to install
twine
(python3 -m pip install --upgrade twine
).
Then simply run python3 -m twine upload dist/*
to upload the package.
Migrate from v1
If you are migrating from v1, you will need to update your code to use the new
client classes.
V1 was synchronous only, using the requests HTTP library. V2 supports both
synchronous and asynchronous code, and multiple HTTP libraries.
To migrate, you will need to:
- Install the http library you want to use (requests, aiohttp, httpx) or use
the built-in urllib.
- Replace
nopecha.api_key
with creating a client instance.
import nopecha
nopecha.api_key = "YOUR_API_KEY"
from nopecha.api.requests import RequestsAPIClient
client = RequestsAPIClient("YOUR_API_KEY")
- Replace
nopecha.Token.solve()
/nopecha.Recognition.solve()
/nopecha.Balance.get()
with the appropriate method on the client instance.
import nopecha
nopecha.api_key = "..."
clicks = nopecha.Recognition.solve(
type='hcaptcha',
task='Please click each image containing a cat-shaped cookie.',
image_urls=[f"https://nopecha.com/image/demo/hcaptcha/{i}.png" for i in range(9)],
)
print(clicks)
token = nopecha.Token.solve(
type='hcaptcha',
sitekey='ab803303-ac41-41aa-9be1-7b4e01b91e2c',
url='https://nopecha.com/demo/hcaptcha',
)
print(token)
balance = nopecha.Balance.get()
print(balance)
from nopecha.api.requests import RequestsAPIClient
client = RequestsAPIClient("YOUR_API_KEY")
clicks = client.recognize_hcaptcha(
'Please click each image containing a cat-shaped cookie.',
[f"https://nopecha.com/image/demo/hcaptcha/{i}.png" for i in range(9)],
)
print(clicks)
token = client.solve_hcaptcha(
'ab803303-ac41-41aa-9be1-7b4e01b91e2c',
'https://nopecha.com/demo/hcaptcha',
)
print(token)
balance = client.status()
print(balance)