Skip to main content

An easy generator of Captcha for Discord bots, creating embeds and images.

Project description

DisCaPty

DisCaPty is a Python module to generate Captcha challenge more easily and with more flexibility. Principally made for Discord bot developers but available for everyone!

PyPI PyPI - Python Version PyPI - Downloads

Installing

DisCaPty is available on PyPi!

python -m pip install -U discapty

You can also clone the module using git:

python -m pip install -U git+https://github.com/Predeactor/DisCapTy

It is still recommended to use PyPi.

Creating Captcha

DisCapTy include 3 differents types of Captcha style.

  • text: A Captcha that use plain text. This type is particular as it include a zero width space character between each letter/number to unallow the user to copy/paste the captcha.
  • wheezy: An image Captcha, pretty basic and easy to read. Configurable
  • image: An image Captcha, a bit more hard to read, less user friendly. Configurable.

You can choose which type to use when creating a Captcha object.

Example:

import discapty

captcha = discapty.Captcha("wheezy")
# You are initializing a Captcha object that is the "wheezy" type.
# If you want to show the image/captcha, use generate_captcha()
captcha_image = captcha.generate_captcha() # <_io.BytesIO object at XxXXX>

However, using the "text" type will not return a BytesIO object but a string.

import discapty

captcha = discapty.Captcha("text")
captcha_image = captcha.generate_captcha() # This will return a string, not a BytesIO object.

You can also easily create an embed.

import discapty

async def send_captcha(ctx):
    captcha = discapty.Captcha("image")
    captcha_image = discord.File(captcha.generate_captcha(), filename="captcha.png") # This is # # important to put this filename, otherwise Discord will send the image outside of the embed.
    # You can change it when generating the embed. 
    captcha_embed = captcha.generate_embed(ctx.guild.name)
    await ctx.channel.send(embed=captcha_embed, file=captcha_image)

Create more complex Captcha

The power of DisCapTy is how it let you customize your Captcha by using the setup function. When using this function, it is recommended to use number that are reasonable enough to not overload your machine. Image creation may take time if you abuse of it, and memory can also go high.

import discapty

def generate_captcha():
    captcha = discapty.Captcha("wheezy")

    # This function is what allow developers to set addition settings for their captcha, refer to the function's help for more parameters to use.
    captcha.setup(width=400, height=400, noise_color="#FF0000")

    return discapty.generate_embed() # Return the image with the settings that has been set.

Contact

You can join my Discord server for any help: https://discord.gg/aPVupKAxxP

DisCapTy is licensied under MIT: PyPI - License DisCapTy use the Roboto font as default font. This font is licensied under Apache-2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

DisCapTy-1.0.3.tar.gz (102.5 kB view details)

Uploaded Source

Built Distribution

DisCapTy-1.0.3-py3-none-any.whl (102.0 kB view details)

Uploaded Python 3

File details

Details for the file DisCapTy-1.0.3.tar.gz.

File metadata

  • Download URL: DisCapTy-1.0.3.tar.gz
  • Upload date:
  • Size: 102.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.8.12

File hashes

Hashes for DisCapTy-1.0.3.tar.gz
Algorithm Hash digest
SHA256 006449c5022e8915adc6c0c53be80819cac75d08eb63930acb0a09fb4937d812
MD5 45d11539859326525fcf84b9082cdd11
BLAKE2b-256 9045a225cbe43cc86f87fc0f4ec0722f8d17ab86cd14a811cf6728621542b70d

See more details on using hashes here.

File details

Details for the file DisCapTy-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: DisCapTy-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 102.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.8.12

File hashes

Hashes for DisCapTy-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 663f5f40733686c42900c37f4fded4e754c03248567f25c37b1578db13b27b11
MD5 c0341f1fe5d2eba584827beedcab4ea9
BLAKE2b-256 7c6b329c902b6f42d42e02be80f5e75e326e01874d064f0f01eaf95f0686928b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page