A lightweight CAPTCHA generator for Persian and English digits
Project description
Light Captcha
A lightweight Python library for generating CAPTCHA images with Persian (۰-۹) and English (0-9) digits.
Features
- ✨ Support for both Persian and English numerals
- 🔒 Random digit skewing and rotation for security
- 📏 Size variations for enhanced difficulty
- 🎯 Millisecond-based random number generation
- 🌊 Wave distortion effects
- 🎨 Random color schemes
- 🔧 Enhanced noise and interference patterns
- 📐 Customizable image dimensions
- 🖼️ NEW in v0.0.2: Output format options (PIL Image or base64)
- 🔧 NEW in v0.0.2: Improved font resource loading for better cross-platform compatibility
Installation
pip install light-captcha
Quick Start
from light_captcha import CaptchaGenerator
# Create generator instance
generator = CaptchaGenerator()
# Generate English CAPTCHA as PIL Image (default)
image, number = generator.generate('english')
image.save('captcha_english.png')
print(f"Generated number: {number}")
# Generate Persian CAPTCHA as base64 string
base64_str, number = generator.generate('persian', output='base64')
print(f"Generated number: {number}")
print(f"Base64 data: {base64_str[:50]}...")
Usage Examples
Output Format Options (New in v0.0.2)
# Generate as PIL Image object (default)
image, number = generator.generate('english', output='image')
image.save('captcha.png')
# Generate as base64 string for web applications
base64_str, number = generator.generate('english', output='base64')
html_img = f'<img src="data:image/png;base64,{base64_str}" alt="CAPTCHA">'
Custom Dimensions
# Generate with custom size
image, number = generator.generate('english', width=300, height=100)
Custom Colors
# Generate with custom colors
bg_color = (240, 248, 255) # Light blue background
text_color = (25, 25, 112) # Navy text
image, number = generator.generate(
'english',
bg_color=bg_color,
text_color=text_color,
output='image'
)
Web Application Integration
generator = CaptchaGenerator()
# For APIs and web frameworks
base64_captcha, correct_answer = generator.generate(
language='english',
width=250,
height=80,
output='base64'
)
# Store correct_answer in session for validation
# Send base64_captcha to frontend
Batch Generation
generator = CaptchaGenerator()
# Generate multiple CAPTCHAs with different formats
for i in range(5):
# Image format
image, number = generator.generate('persian', output='image')
image.save(f'captcha_img_{i}.png')
# Base64 format
base64_str, number = generator.generate('english', output='base64')
with open(f'captcha_b64_{i}.txt', 'w') as f:
f.write(base64_str)
print(f"CAPTCHA {i}: {number}")
API Reference
CaptchaGenerator
generate(language, width=250, height=80, bg_color=None, text_color=None, output='image')
Generate a CAPTCHA image.
Parameters:
language(str):'english'or'persian'width(int): Image width in pixels (default: 250)height(int): Image height in pixels (default: 80)bg_color(tuple, optional): RGB background colortext_color(tuple, optional): RGB text coloroutput(str):'image'for PIL Image object or'base64'for base64 string (default: 'image')
Returns:
tuple: (PIL Image object or base64 string, 6-digit string)
Raises:
ValueError: If language is not 'english' or 'persian'ValueError: If output is not 'image' or 'base64'FileNotFoundError: If required font file is missing
What's New in v0.0.2
Enhanced Font Loading
- Improved font resource loading using
importlib.resourcesfor better cross-platform compatibility - Automatic fallback mechanisms for different Python versions
- Resolves PIL font format errors when package is installed system-wide
Output Format Options
- Image Output: Returns PIL Image object (default, backward compatible)
- Base64 Output: Returns base64-encoded PNG string for direct web integration
Better Error Handling
- More descriptive error messages for font loading issues
- Validation for output format parameter
- Improved cross-platform compatibility
Security Features
- Random Skewing: Each digit rotated -15° to +15°
- Size Variation: Random scaling 0.8x to 1.2x per digit
- Wave Distortion: Sinusoidal distortion across the image
- Noise Patterns: Curved lines and random dots
- Color Randomization: Multiple predefined color schemes
- Millisecond Seeding: High-precision random generation
Requirements
- Python 3.7+
- Pillow >= 8.0.0
- importlib_resources >= 1.3.0 (for Python < 3.9)
License
MIT License - see LICENSE file for details.
Contributing
Issues and pull requests are welcome on GitHub.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file light_captcha-0.0.2.tar.gz.
File metadata
- Download URL: light_captcha-0.0.2.tar.gz
- Upload date:
- Size: 132.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
36a8e39df1100ea7320f7516c60e7d5dfea6612bdba5ac199ee96e15c4316ad6
|
|
| MD5 |
7880d85234c6f7e9b5afe6e6b79227ad
|
|
| BLAKE2b-256 |
dfd2acee7171faa0b5dc3b8343fca4ca961e1c9dcc1d5b528f0cca7aa2605c07
|
File details
Details for the file light_captcha-0.0.2-py3-none-any.whl.
File metadata
- Download URL: light_captcha-0.0.2-py3-none-any.whl
- Upload date:
- Size: 129.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d8e59683249ea9499abddd57e8cba2fbeff5df408e0630c9e29bfb6bc410e213
|
|
| MD5 |
30cb661413bce06b910160c8bb63b97c
|
|
| BLAKE2b-256 |
03aee8ee2ec32e1cec647df41abd331142ae8285ee4a1e0a4e40f0d9a868997f
|