textbaker 0.1.0__tar.gz

textbaker-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ramkrishna Acharya
+
+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.

textbaker-0.1.0/PKG-INFO

@@ -0,0 +1,380 @@
+Metadata-Version: 2.4
+Name: textbaker
+Version: 0.1.0
+Summary: Synthetic Text Dataset Generator for OCR Training
+Author: Ramkrishna Acharya
+Maintainer: Ramkrishna Acharya
+License: MIT
+Project-URL: Homepage, https://github.com/q-viper/text-baker
+Project-URL: Documentation, https://q-viper.github.io/text-baker
+Project-URL: Repository, https://github.com/q-viper/text-baker
+Project-URL: Issues, https://github.com/q-viper/text-baker/issues
+Keywords: ocr,dataset,synthetic,text,image-generation,machine-learning
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.21.0
+Requires-Dist: opencv-python>=4.5.0
+Requires-Dist: PySide6>=6.4.0
+Requires-Dist: loguru>=0.6.0
+Requires-Dist: typer[all]>=0.9.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pyyaml>=6.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: pytest-qt>=4.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=0.990; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5.0; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0.0; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.24.0; extra == "docs"
+Dynamic: license-file
+
+# 🍞 TextBaker
+
+[![CI](https://github.com/q-viper/text-baker/actions/workflows/ci.yml/badge.svg)](https://github.com/q-viper/text-baker/actions/workflows/ci.yml)
+[![PyPI version](https://badge.fury.io/py/textbaker.svg)](https://badge.fury.io/py/textbaker)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**Synthetic Text Dataset Generator for OCR Training**
+
+TextBaker is a powerful tool for generating synthetic text images by combining character datasets with backgrounds and applying various transformations. Perfect for training OCR models, data augmentation, and creating synthetic datasets.
+
+![TextBaker Demo](assets/icon.png)
+
+## ✨ Features
+
+- 🎨 **GUI Application** - Interactive interface for real-time text generation
+- 🖥️ **CLI Tool** - Batch processing from command line
+- 📚 **Python Library** - Programmatic API for integration
+- 🔄 **Transformations** - Rotation, perspective, scale, shear
+- 🎭 **Textures** - Apply texture overlays to text
+- 🖼️ **Backgrounds** - Composite text on background images
+- 🎲 **Random Generation** - Generate random text with configurable parameters
+- 🔧 **YAML/JSON Configs** - Save and load configurations
+- 🎯 **Reproducible** - Seed-based random generation for reproducibility
+
+## 📦 Installation
+
+### From PyPI
+
+```bash
+pip install textbaker
+```
+
+### From Source
+
+```bash
+git clone https://github.com/q-viper/text-baker.git
+cd text-baker
+pip install -e .
+```
+
+### With Development Dependencies
+
+```bash
+pip install -e ".[dev]"
+```
+
+## 🚀 Quick Start
+
+### GUI Application
+
+Launch the interactive GUI:
+
+```bash
+textbaker
+```
+
+Or with pre-configured paths:
+
+```bash
+textbaker -d ./dataset -o ./output -b ./backgrounds -t ./textures
+```
+
+### Command Line
+
+Generate text images from the command line:
+
+```bash
+# Generate specific texts
+textbaker generate "Hello" "World" -d ./dataset -o ./output
+
+# Generate 100 random samples
+textbaker generate -n 100 --seed 42 -d ./dataset
+
+# Apply transformations
+textbaker generate "Hello" --rotation "-15,15" --perspective "0,0.1"
+
+# With backgrounds and textures
+textbaker generate "Hello" -b ./backgrounds -t ./textures --texture-opacity 0.8
+```
+
+### Python Library
+
+```python
+from textbaker import TextGenerator, GeneratorConfig, TransformConfig
+
+# Simple usage
+generator = TextGenerator()
+result = generator.generate("Hello")
+generator.save(result)
+
+# With custom configuration
+config = GeneratorConfig(
+    seed=42,
+    dataset={"dataset_dir": "./my_dataset"},
+    transform=TransformConfig(
+        rotation_range=(-15, 15),
+        perspective_range=(0, 0.1),
+        scale_range=(0.9, 1.1),
+    ),
+    output={"output_dir": "./output"},
+)
+
+generator = TextGenerator(config)
+
+# Generate specific text
+result = generator.generate("TextBaker")
+print(f"Generated: {result.text}, Labels: {result.labels}")
+
+# Generate random text
+result = generator.generate_random(length=5)
+
+# Batch generation
+results = generator.batch_generate(["Hello", "World", "Test"])
+```
+
+## 📁 Dataset Structure
+
+Organize your character images in folders named by the character:
+
+```
+dataset/
+├── A/
+│   ├── sample1.png
+│   ├── sample2.png
+│   └── ...
+├── B/
+│   └── ...
+├── 0/
+│   └── ...
+└── special_char/
+    └── ...
+```
+
+Each character folder should contain PNG images (preferably with transparency) of that character in various styles.
+
+## ⚙️ Configuration
+
+### YAML Configuration
+
+Create a config file:
+
+```bash
+textbaker init-config -o config.yaml
+```
+
+Example `config.yaml`:
+
+```yaml
+seed: 42
+dataset:
+  dataset_dir: ./dataset
+  recursive: true
+  extensions: [".png", ".jpg"]
+transform:
+  rotation_range: [-15, 15]
+  perspective_range: [0, 0.1]
+  scale_range: [0.9, 1.1]
+  shear_range: [0, 0]
+color:
+  random_color: true
+  color_range_r: [0, 255]
+  color_range_g: [0, 255]
+  color_range_b: [0, 255]
+texture:
+  enabled: true
+  texture_dir: ./textures
+  opacity: 0.8
+background:
+  enabled: true
+  background_dir: ./backgrounds
+output:
+  output_dir: ./output
+  format: png
+```
+
+Use with CLI:
+
+```bash
+textbaker generate "Hello" --config config.yaml
+```
+
+Or in Python:
+
+```python
+from textbaker import GeneratorConfig, TextGenerator
+
+config = GeneratorConfig.from_file("config.yaml")
+generator = TextGenerator(config)
+```
+
+## 🎨 GUI Features
+
+- **Character Selection** - Select which characters to use
+- **Real-time Preview** - See generated text instantly
+- **Drag & Drop** - Position text on canvas
+- **Resize & Rotate** - Interactive handles for transformation
+- **Texture Picker** - Select texture regions interactively
+- **Background Selection** - Choose random backgrounds
+- **Export** - Save generated images and configurations
+
+### Keyboard Shortcuts
+
+| Shortcut | Action |
+|----------|--------|
+| Mouse Wheel | Zoom in/out |
+| Space + Drag | Pan view |
+| Click + Drag | Move text |
+| Corner handles | Resize text |
+| Center handle | Rotate text |
+
+## 🔧 CLI Commands
+
+```bash
+# Show help
+textbaker --help
+
+# Launch GUI
+textbaker gui
+
+# Generate images
+textbaker generate --help
+
+# Create config file
+textbaker init-config --help
+```
+
+### Generate Command Options
+
+| Option | Description |
+|--------|-------------|
+| `-d, --dataset` | Path to character dataset |
+| `-o, --output` | Output directory |
+| `-b, --background` | Background images directory |
+| `-t, --texture` | Texture images directory |
+| `-n, --count` | Number of random samples |
+| `--seed` | Random seed for reproducibility |
+| `-r, --rotation` | Rotation range (e.g., "-15,15") |
+| `-p, --perspective` | Perspective range (e.g., "0,0.1") |
+| `--scale` | Scale range (e.g., "0.9,1.1") |
+| `--random-color` | Enable random coloring |
+| `--color` | Fixed color (e.g., "255,0,0") |
+| `--config` | Load from config file |
+
+## 📖 API Reference
+
+### TextGenerator
+
+```python
+class TextGenerator:
+    def __init__(self, config: GeneratorConfig = None): ...
+    def generate(self, text: str) -> GenerationResult: ...
+    def generate_random(self, length: int = None) -> GenerationResult: ...
+    def batch_generate(self, texts: list[str]) -> list[GenerationResult]: ...
+    def save(self, result: GenerationResult, filename: str = None) -> Path: ...
+    @property
+    def available_characters(self) -> list[str]: ...
+```
+
+### GenerationResult
+
+```python
+@dataclass
+class GenerationResult:
+    image: np.ndarray  # BGRA image array
+    text: str          # Generated text
+    labels: list[str]  # Character labels
+    seed: int          # Seed used
+    params: dict       # Generation parameters
+```
+
+### Configuration Classes
+
+- `GeneratorConfig` - Main configuration
+- `TransformConfig` - Transformation settings
+- `ColorConfig` - Color settings
+- `TextureConfig` - Texture settings
+- `BackgroundConfig` - Background settings
+- `DatasetConfig` - Dataset settings
+- `OutputConfig` - Output settings
+
+## 🧪 Development
+
+### Setup
+
+```bash
+git clone https://github.com/q-viper/text-baker.git
+cd text-baker
+pip install -e ".[dev]"
+```
+
+### Run Tests
+
+```bash
+pytest tests/ -v
+```
+
+### Run Linting
+
+```bash
+ruff check .
+ruff format .
+```
+
+### Build Documentation
+
+```bash
+mkdocs serve
+```
+
+## 📄 License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 👤 Author
+
+**Ramkrishna Acharya** ([@q-viper](https://github.com/q-viper))
+
+## 🙏 Acknowledgments
+
+- Built with [PySide6](https://doc.qt.io/qtforpython-6/)
+- Image processing with [OpenCV](https://opencv.org/)
+- CLI powered by [Typer](https://typer.tiangolo.com/)