Welcome to DisCapTy’s documentation!#

_images/logo.png _images/logo-dark.png

DisCapTy is a highly type hinted Python module to generate Captcha images & challenges without struggling your mind on how to make your own.

Features:

  • Highly customizable Captcha generation / Hackable

  • Developer & user friendly

  • Highly type hinted

  • Extendable with your own/third-party generators

Installation#

To install DisCapTy, run the following command in your wished environment:

pip install -U DisCapTy

With Poetry:

peotry add DisCapTy

Example#

from discapty import Challenge, ImageGenerator, TooManyRetriesError

challenge = Challenge(ImageGenerator(width=500, height=250, fonts=["./my-fonts.ttf"]), allowed_retries=5)
captcha = challenge.begin()  # Thank to DisCapTy's typehint, we know we're getting an image here!
send_captcha_to_user(captcha)

user_input = get_user_input()

try:
    is_valid = challenge.check(user_input)
    if is_valid:
        print("You're correct!")
    else:
        print("You're incorrect, try again!")
        # And here, do something to get user's input & check again.
except TooManyRetriesError:
    print("You've made too many errors!")

Pages#