bengali-captcha 0.1.0__tar.gz

bengali_captcha-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Bengali CAPTCHA contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bengali_captcha-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md PUBLISHING.md LICENSE
+recursive-include licenses *.txt
+recursive-include tests *.py
+recursive-include src/bengali_captcha/assets *.ttf *.png *.jpg

bengali_captcha-0.1.0/PKG-INFO

@@ -0,0 +1,283 @@
+Metadata-Version: 2.4
+Name: bengali-captcha
+Version: 0.1.0
+Summary: Seven Bengali CAPTCHA variants with original fonts and backgrounds included
+License-Expression: MIT
+Keywords: bengali,bangla,captcha,pillow,image
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: Bengali
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: licenses/CLAPTCHA.txt
+Requires-Dist: Pillow>=10.1
+Provides-Extra: release
+Requires-Dist: build>=1.2; extra == "release"
+Requires-Dist: twine>=6; extra == "release"
+Dynamic: license-file
+
+# Bengali CAPTCHA
+
+**Generate Bengali (Bangla) CAPTCHA images in Python, with bundled fonts and backgrounds.**
+
+`bengali-captcha` is a Pillow-based library for creating image CAPTCHAs with
+Bengali letters and digits. Adapted from the `captchaWeb` research application,
+it provides seven rendering variants through a simple Python API and supports
+Pillow images, in-memory streams, and image files.
+
+**The PyPI package includes the original Bengali fonts and background images.**
+Installing it with `pip` installs those assets too. All seven CAPTCHA variants
+select their bundled assets automatically: no font path, background path,
+separate download, or configuration is required.
+
+The project is associated with the research paper
+[**A Usable and Secure Bengali CAPTCHA**](https://arxiv.org/abs/2606.29077).
+If you use this library in your research, please cite the paper using the
+BibTeX entry in the **Citation** section below.
+
+## Sample CAPTCHA
+
+## Sample CAPTCHA
+
+![Sample Bengali CAPTCHA](https://raw.githubusercontent.com/neyamul-sbr/ArtifactsBengaliCAPTCHA/d69a0ddd4d0f2cf5d8297db4d141bc1b5fd76f43/ben_captcha.png)
+
+## Features
+
+- Seven rendering variants with automatically selected fonts and backgrounds.
+- Bundled assets for offline generation after installation.
+- Random Bengali challenge text generated using Python's `secrets` module.
+- Custom challenge text, text-source callables, and configurable random-text length.
+- Adjustable image size, margins, noise, and output format.
+- Optional custom fonts, backgrounds, and supported text colors.
+- Pillow image, in-memory stream, and file output.
+- Command-line interface and a Django integration example.
+
+## Installation
+
+Requires **Python 3.10 or newer**.
+
+```console
+python -m pip install bengali-captcha
+```
+
+## Quick start
+
+The original Bengali fonts and background images are included. Generate a
+CAPTCHA immediately, with no font downloads or custom image paths:
+
+```python
+from bengali_captcha import BengaliCaptcha
+
+captcha = BengaliCaptcha()
+answer, image = captcha.image
+image.save("captcha.png")
+```
+
+All seven variants work out of the box:
+
+```python
+for variant in range(1, 8):
+    answer, path = BengaliCaptcha(variant=variant).write(f"captcha-{variant}.png")
+```
+
+By default, the answer contains four characters from the original project's
+Bengali alphabet and digit selection. Challenge text uses `secrets` randomness.
+Pass `length=5` to change the length, or supply a string or callable as `source`.
+
+To generate a longer random challenge:
+
+```python
+captcha = BengaliCaptcha(length=5)
+answer, image = captcha.image
+image.save("captcha.png")
+```
+
+## Output options
+
+| API | Returns |
+| --- | --- |
+| `captcha.image` | `(answer, image)`, where `image` is a Pillow image |
+| `captcha.bytes` | `(answer, stream)`, where `stream` is a `BytesIO` object positioned at the beginning |
+| `captcha.write("captcha.png")` | `(answer, path)`, after writing a newly generated image to disk |
+
+Generate image bytes using the included assets:
+
+```python
+captcha = BengaliCaptcha(variant=2, source="কখ১২")
+answer, stream = captcha.bytes  # BytesIO, positioned at the beginning
+png_data = stream.getvalue()
+```
+
+To generate and save directly to a file:
+
+```python
+answer, path = captcha.write("captcha.png")
+```
+
+**Each access to `.image`, `.bytes`, or `.write()` creates a new image and calls
+the text source again.** Keep the answer returned by the same call as the image
+you display. To save that exact image, use its `.save()` method as shown in the
+quick start.
+
+
+## Command-line usage
+
+```console
+bengali-captcha captcha.png
+bengali-captcha captcha.png --variant 1 --length 4
+python -m bengali_captcha captcha.png --variant 7
+```
+
+These commands use the included fonts and images. The only filename required
+is where to save the generated PNG. The command prints its answer in UTF-8.
+
+## Django integration
+
+Generate bytes for each request and keep the corresponding answer in the
+user's session. For example, inside a Django view:
+
+```python
+from django.http import HttpResponse
+from bengali_captcha import BengaliCaptcha
+
+
+def captcha_image(request):
+    answer, stream = BengaliCaptcha().bytes
+    request.session["captcha_answer"] = answer
+    response = HttpResponse(stream.getvalue(), content_type="image/png")
+    response["Cache-Control"] = "no-store"
+    return response
+```
+
+Your form-processing view must validate the submitted answer against the stored
+value and enforce challenge expiration, one-time use, and rate limiting. Keep
+the answer on the server; the image response should contain only the image.
+
+The original Django site remains in this repository. The distribution includes
+`bengali_captcha` and its original fonts/backgrounds; it does not install the
+site or its settings.
+The separate `gen_captcha_6/7/8` functions in `main/views.py` remain part of that
+site and are not exposed by this library release.
+
+## Optional: use your own font or background
+
+Skip this section to use the original CAPTCHA styles. Supply `font` or
+`background` only when you want to replace a bundled asset; each override is
+independent, so the asset you do not override keeps its bundled default.
+
+```python
+from bengali_captcha import BengaliCaptcha
+
+# Optional custom font; the background still comes from the package.
+captcha = BengaliCaptcha(variant=2, font="my-bengali-font.ttf")
+
+# Optional custom background; the font still comes from the package.
+captcha = BengaliCaptcha(variant=2, background="my-background.png")
+
+# Optional: replace both assets.
+captcha = BengaliCaptcha(
+    variant=2,
+    font="my-bengali-font.ttf",
+    background="my-background.png",
+)
+answer, image = captcha.image
+```
+
+Custom fonts must support Bengali characters. A custom font path or Pillow
+font object works with every variant. Custom backgrounds apply to variants
+2, 3, 5, 6 and 7. Omitting either argument or passing `None` uses its bundled
+default; `background=False` selects a white canvas.
+
+The command line also accepts optional overrides:
+
+```console
+bengali-captcha captcha.png --variant 2 --font my-bengali-font.ttf --background my-background.png
+```
+
+## Scope and limitations
+
+- **Character rendering:** The renderers distort individual characters. The
+  default alphabet uses standalone Bengali letters and digits. Arbitrary
+  Bengali words containing combining marks or conjuncts are not supported as
+  shaped text.
+- **Application integration:** This package generates CAPTCHA images. Answer
+  validation, expiration, one-time use, and rate limiting belong to the
+  integrating application.
+- **Research scope:** The paper evaluates six CAPTCHA variants in its research
+  implementation. This package exposes seven renderer APIs; their numbering
+  should not be assumed to correspond directly to the paper's evaluated
+  variants. The standalone package's resistance to automated solving has not
+  been separately evaluated.
+
+## Citation
+
+If you use **Bengali CAPTCHA** in your research, experiments, or academic
+publications, please cite the following paper:
+
+Md Neyamul Islam Shibbir, Md Hasibur Rahman, Farida Chowdhury, and Md Sadek
+Ferdous. **A Usable and Secure Bengali CAPTCHA.** arXiv preprint
+arXiv:2606.29077, 2026.
+
+[Read the paper on arXiv](https://arxiv.org/abs/2606.29077).
+
+```bibtex
+@article{shibbir2026usable,
+  title={A Usable and Secure Bengali CAPTCHA},
+  author={Shibbir, Md Neyamul Islam and Rahman, Md Hasibur and Chowdhury, Farida and Ferdous, Md Sadek},
+  journal={arXiv preprint arXiv:2606.29077},
+  year={2026}
+}
+```
+
+## Development and publishing
+
+From the repository root, install the package in editable mode:
+
+```console
+python -m pip install -e .
+```
+
+Install the release tools, run the tests, build the distributions, and check
+the package metadata:
+
+```console
+python -m pip install -e ".[release]"
+python -m unittest discover -s tests -v
+python -m build
+python -m twine check --strict dist/*
+```
+
+## Acknowledgements
+
+The generators are loosely derived from
+[Claptcha by Piotr Kuszaj](https://github.com/kuszaj/claptcha).
+Bengali-specific variant changes originate in the `captchaWeb` research application.
+
+## License and credits
+
+MIT License
+
+Copyright (c) 2026 Md Neyamul Islam Shibbir, Md Hasibur Rahman, Md Sadek Ferdous, Farida Chowdhury
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bengali_captcha-0.1.0/README.md

@@ -0,0 +1,260 @@
+# Bengali CAPTCHA
+
+**Generate Bengali (Bangla) CAPTCHA images in Python, with bundled fonts and backgrounds.**
+
+`bengali-captcha` is a Pillow-based library for creating image CAPTCHAs with
+Bengali letters and digits. Adapted from the `captchaWeb` research application,
+it provides seven rendering variants through a simple Python API and supports
+Pillow images, in-memory streams, and image files.
+
+**The PyPI package includes the original Bengali fonts and background images.**
+Installing it with `pip` installs those assets too. All seven CAPTCHA variants
+select their bundled assets automatically: no font path, background path,
+separate download, or configuration is required.
+
+The project is associated with the research paper
+[**A Usable and Secure Bengali CAPTCHA**](https://arxiv.org/abs/2606.29077).
+If you use this library in your research, please cite the paper using the
+BibTeX entry in the **Citation** section below.
+
+## Sample CAPTCHA
+
+## Sample CAPTCHA
+
+![Sample Bengali CAPTCHA](https://raw.githubusercontent.com/neyamul-sbr/ArtifactsBengaliCAPTCHA/d69a0ddd4d0f2cf5d8297db4d141bc1b5fd76f43/ben_captcha.png)
+
+## Features
+
+- Seven rendering variants with automatically selected fonts and backgrounds.
+- Bundled assets for offline generation after installation.
+- Random Bengali challenge text generated using Python's `secrets` module.
+- Custom challenge text, text-source callables, and configurable random-text length.
+- Adjustable image size, margins, noise, and output format.
+- Optional custom fonts, backgrounds, and supported text colors.
+- Pillow image, in-memory stream, and file output.
+- Command-line interface and a Django integration example.
+
+## Installation
+
+Requires **Python 3.10 or newer**.
+
+```console
+python -m pip install bengali-captcha
+```
+
+## Quick start
+
+The original Bengali fonts and background images are included. Generate a
+CAPTCHA immediately, with no font downloads or custom image paths:
+
+```python
+from bengali_captcha import BengaliCaptcha
+
+captcha = BengaliCaptcha()
+answer, image = captcha.image
+image.save("captcha.png")
+```
+
+All seven variants work out of the box:
+
+```python
+for variant in range(1, 8):
+    answer, path = BengaliCaptcha(variant=variant).write(f"captcha-{variant}.png")
+```
+
+By default, the answer contains four characters from the original project's
+Bengali alphabet and digit selection. Challenge text uses `secrets` randomness.
+Pass `length=5` to change the length, or supply a string or callable as `source`.
+
+To generate a longer random challenge:
+
+```python
+captcha = BengaliCaptcha(length=5)
+answer, image = captcha.image
+image.save("captcha.png")
+```
+
+## Output options
+
+| API | Returns |
+| --- | --- |
+| `captcha.image` | `(answer, image)`, where `image` is a Pillow image |
+| `captcha.bytes` | `(answer, stream)`, where `stream` is a `BytesIO` object positioned at the beginning |
+| `captcha.write("captcha.png")` | `(answer, path)`, after writing a newly generated image to disk |
+
+Generate image bytes using the included assets:
+
+```python
+captcha = BengaliCaptcha(variant=2, source="কখ১২")
+answer, stream = captcha.bytes  # BytesIO, positioned at the beginning
+png_data = stream.getvalue()
+```
+
+To generate and save directly to a file:
+
+```python
+answer, path = captcha.write("captcha.png")
+```
+
+**Each access to `.image`, `.bytes`, or `.write()` creates a new image and calls
+the text source again.** Keep the answer returned by the same call as the image
+you display. To save that exact image, use its `.save()` method as shown in the
+quick start.
+
+
+## Command-line usage
+
+```console
+bengali-captcha captcha.png
+bengali-captcha captcha.png --variant 1 --length 4
+python -m bengali_captcha captcha.png --variant 7
+```
+
+These commands use the included fonts and images. The only filename required
+is where to save the generated PNG. The command prints its answer in UTF-8.
+
+## Django integration
+
+Generate bytes for each request and keep the corresponding answer in the
+user's session. For example, inside a Django view:
+
+```python
+from django.http import HttpResponse
+from bengali_captcha import BengaliCaptcha
+
+
+def captcha_image(request):
+    answer, stream = BengaliCaptcha().bytes
+    request.session["captcha_answer"] = answer
+    response = HttpResponse(stream.getvalue(), content_type="image/png")
+    response["Cache-Control"] = "no-store"
+    return response
+```
+
+Your form-processing view must validate the submitted answer against the stored
+value and enforce challenge expiration, one-time use, and rate limiting. Keep
+the answer on the server; the image response should contain only the image.
+
+The original Django site remains in this repository. The distribution includes
+`bengali_captcha` and its original fonts/backgrounds; it does not install the
+site or its settings.
+The separate `gen_captcha_6/7/8` functions in `main/views.py` remain part of that
+site and are not exposed by this library release.
+
+## Optional: use your own font or background
+
+Skip this section to use the original CAPTCHA styles. Supply `font` or
+`background` only when you want to replace a bundled asset; each override is
+independent, so the asset you do not override keeps its bundled default.
+
+```python
+from bengali_captcha import BengaliCaptcha
+
+# Optional custom font; the background still comes from the package.
+captcha = BengaliCaptcha(variant=2, font="my-bengali-font.ttf")
+
+# Optional custom background; the font still comes from the package.
+captcha = BengaliCaptcha(variant=2, background="my-background.png")
+
+# Optional: replace both assets.
+captcha = BengaliCaptcha(
+    variant=2,
+    font="my-bengali-font.ttf",
+    background="my-background.png",
+)
+answer, image = captcha.image
+```
+
+Custom fonts must support Bengali characters. A custom font path or Pillow
+font object works with every variant. Custom backgrounds apply to variants
+2, 3, 5, 6 and 7. Omitting either argument or passing `None` uses its bundled
+default; `background=False` selects a white canvas.
+
+The command line also accepts optional overrides:
+
+```console
+bengali-captcha captcha.png --variant 2 --font my-bengali-font.ttf --background my-background.png
+```
+
+## Scope and limitations
+
+- **Character rendering:** The renderers distort individual characters. The
+  default alphabet uses standalone Bengali letters and digits. Arbitrary
+  Bengali words containing combining marks or conjuncts are not supported as
+  shaped text.
+- **Application integration:** This package generates CAPTCHA images. Answer
+  validation, expiration, one-time use, and rate limiting belong to the
+  integrating application.
+- **Research scope:** The paper evaluates six CAPTCHA variants in its research
+  implementation. This package exposes seven renderer APIs; their numbering
+  should not be assumed to correspond directly to the paper's evaluated
+  variants. The standalone package's resistance to automated solving has not
+  been separately evaluated.
+
+## Citation
+
+If you use **Bengali CAPTCHA** in your research, experiments, or academic
+publications, please cite the following paper:
+
+Md Neyamul Islam Shibbir, Md Hasibur Rahman, Farida Chowdhury, and Md Sadek
+Ferdous. **A Usable and Secure Bengali CAPTCHA.** arXiv preprint
+arXiv:2606.29077, 2026.
+
+[Read the paper on arXiv](https://arxiv.org/abs/2606.29077).
+
+```bibtex
+@article{shibbir2026usable,
+  title={A Usable and Secure Bengali CAPTCHA},
+  author={Shibbir, Md Neyamul Islam and Rahman, Md Hasibur and Chowdhury, Farida and Ferdous, Md Sadek},
+  journal={arXiv preprint arXiv:2606.29077},
+  year={2026}
+}
+```
+
+## Development and publishing
+
+From the repository root, install the package in editable mode:
+
+```console
+python -m pip install -e .
+```
+
+Install the release tools, run the tests, build the distributions, and check
+the package metadata:
+
+```console
+python -m pip install -e ".[release]"
+python -m unittest discover -s tests -v
+python -m build
+python -m twine check --strict dist/*
+```
+
+## Acknowledgements
+
+The generators are loosely derived from
+[Claptcha by Piotr Kuszaj](https://github.com/kuszaj/claptcha).
+Bengali-specific variant changes originate in the `captchaWeb` research application.
+
+## License and credits
+
+MIT License
+
+Copyright (c) 2026 Md Neyamul Islam Shibbir, Md Hasibur Rahman, Md Sadek Ferdous, Farida Chowdhury
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bengali_captcha-0.1.0/licenses/CLAPTCHA.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017 Piotr Kuszaj 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

bengali_captcha-0.1.0/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["setuptools>=77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "bengali-captcha"
+version = "0.1.0"
+description = "Seven Bengali CAPTCHA variants with original fonts and backgrounds included"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE", "licenses/*.txt"]
+dependencies = ["Pillow>=10.1"]
+keywords = ["bengali", "bangla", "captcha", "pillow", "image"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Natural Language :: Bengali",
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Topic :: Multimedia :: Graphics",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.optional-dependencies]
+release = ["build>=1.2", "twine>=6"]
+
+[project.scripts]
+bengali-captcha = "bengali_captcha.__main__:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["bengali_captcha*"]
+namespaces = false
+
+[tool.setuptools]
+include-package-data = false
+
+[tool.setuptools.package-data]
+bengali_captcha = ["assets/fonts/*.ttf", "assets/backgrounds/*.png", "assets/backgrounds/*.jpg"]

bengali_captcha-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+