Skip to content

Latest commit

 

History

History
39 lines (31 loc) · 1.38 KB

README.md

File metadata and controls

39 lines (31 loc) · 1.38 KB
Raw

hcaptcha

hcaptcha is a Python module (unofficial) that provides an easy-to-use interface for verifying hcaptcha responses using the hcaptcha verification API.

Installation

You can install hcaptcha using pip:

pip install hcaptcha

Usage

To use hcaptcha, you'll need an hcaptcha secret key for your site. You can get one by signing up for an account at hcaptcha website.

from hcaptcha.hcaptcha import HCaptchaVerifier, HCaptchaVerificationError
import asyncio

# Initialize the verifier with your hcaptcha secret key
verifier = HCaptchaVerifier(your_hcaptcha_secret_key)

# Verify an hcaptcha response
# You can use await instead of asyncio.run if you are in a async function
try:
    is_valid = asyncio.run(verifier.verify(user_response_token))
    if is_valid:
        print("Captcha verified successfully.")
    else:
        print("Captcha verification failed.")
except HCaptchaVerificationError as e:
    print(f"Verification failed with error: {str(e)}")

Documentation

Documentation for hcaptcha is available here

Contributing

If you find a bug or have a feature request, please open an issue on GitHub.

Licence

hcaptcha is distributed under the MIT License. See LICENSE for more information.