A package for generating Dolze templates
Project description
Dolze Templates A powerful Python library for generating stunning, dynamic images using JSON templates
Overview Dolze Templates is a versatile Python library designed to simplify the creation of dynamic, visually appealing images through intuitive JSON templates. Perfect for generating social media posts, marketing materials, product showcases, and more, Dolze Templates empowers developers to craft professional-grade visuals with minimal effort. ✨ Features
Dynamic Image Generation: Create stunning images programmatically using JSON templates. Rich Component Library: Includes text, images, buttons, shapes, HTML/CSS, and more for flexible designs. HTML Rendering: Create templates using HTML and CSS for maximum flexibility and customization. High Performance: Optimized with intelligent caching for fast image generation. Extensible Architecture: Easily add custom components and templates to suit your needs. Advanced Styling: Supports transparency, gradients, shadows, and other visual effects. Responsive Design: Templates adapt seamlessly to various dimensions and resolutions. Robust Validation: Comprehensive input validation with clear, helpful error messages. CLI Support: Process templates efficiently using the built-in command-line interface.
📦 Installation Dolze Templates requires Python 3.8 or higher. Install the latest version from PyPI: pip install dolze-templates
Optional Dependencies Enhance functionality with additional dependencies:
For image processing
pip install dolze-templates[images]
For advanced text rendering
pip install dolze-templates[text]
For HTML rendering capabilities
pip install dolze-templates[html]
For all optional dependencies
pip install dolze-templates[all]
Development Setup To contribute or modify the source code: git clone https://github.com/yourusername/dolze-templates.git cd dolze-templates python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate pip install -e ".[dev]" pytest # Run tests
🚀 Quick Start Basic Usage Render a template with a few lines of code: from dolze_image_templates import TemplateEngine
Initialize the template engine
engine = TemplateEngine(output_dir="./output", cache_dir="./cache")
Process a template
result = engine.process_from_file("templates/social_media_post.json") print(f"Generated: {result}")
Rendering with Variables Dynamically populate templates with custom data: from dolze_image_templates import TemplateEngine
engine = TemplateEngine() context = { "heading": "Welcome to Dolze", "subheading": "Create amazing images with ease", "image_url": "https://example.com/hero.jpg" } result = engine.process_template("brand_info", template_config, context) print(f"Image saved to: {result}")
Command-Line Interface Use the CLI for quick template processing:
Render a single template
dolze-templates render templates/post.json -o output/
Process all templates in a directory
dolze-templates render templates/ -o output/ --recursive
Clear cache
dolze-templates cache clear
🎨 Available Templates
Template Name Description Sample
brand_info Professional brand information card View Sample
quote_template Elegant quote display with styling View Sample
product_showcase Product showcase with details and images View Sample
Explore more templates in the examples/ directory. 🧩 Components Dolze Templates provides a rich set of built-in components: Text Component { "type": "text", "text": "Hello, World!", "position": [100, 200], "font_size": 36, "color": [0, 0, 0, 255], "font_path": "Poppins-Bold", "max_width": 800 }
Image Component { "type": "image", "image_url": "https://example.com/image.jpg", "position": [0, 0], "size": [800, 600], "border_radius": 10, "opacity": 0.9 }
HTML Component { "type": "html", "html_content": "
${title}
${content}
Button Component { "type": "cta_button", "text": "Click Me", "position": [100, 400], "size": [200, 50], "bg_color": [33, 150, 243, 255], "text_color": [255, 255, 255, 255], "corner_radius": 25 }
🛠️ Advanced Usage Custom Components Extend functionality by creating custom components: from dolze_image_templates.components import Component from PIL import Image, ImageDraw
class CustomShapeComponent(Component): def init(self, position, size, color, **kwargs): super().init(position=position, **kwargs) self.size = size self.color = color
def render(self, image, context):
draw = ImageDraw.Draw(image)
draw.rectangle(
[self.x, self.y, self.x + self.size[0], self.y + self.size[1]],
fill=tuple(self.color)
)
return image
Register the component
from dolze_image_templates import get_template_registry registry = get_template_registry() registry.register_component('custom_shape', CustomShapeComponent)
Template Structure Define templates using JSON: { "name": "social_media_post", "settings": { "size": [1080, 1080], "background_color": [255, 255, 255, 255] }, "components": [ { "type": "text", "text": "${greeting}", "position": [100, 100], "font_size": 64, "color": [0, 0, 0, 255] } ] }
📋 Template Variables Templates support dynamic variables for flexible content:
logo_url: URL to your logo image_url: URL to the main image heading: Primary text subheading: Secondary text cta_text: Call-to-action text contact_email: Contact email contact_phone: Contact phone website_url: Website URL quote: Quote text for quote templates
📚 API Reference TemplateEngine The core class for processing templates: engine = TemplateEngine( output_dir='output', cache_dir='.cache', auto_create_dirs=True ) result = engine.process_from_file('template.json')
TemplateRegistry Manages components and template loaders: registry = get_template_registry() registry.register_component('custom', CustomComponent)
🤝 Contributing We welcome contributions! To get started:
Fork the repository Create a feature branch: git checkout -b feature/your-feature Commit changes: git commit -m 'Add your feature' Push to the branch: git push origin feature/your-feature Open a pull request
See Contributing Guidelines for details. 📄 License This project is licensed under the MIT License. See the LICENSE file for details. 📬 Contact For support or inquiries, open an issue on GitHub or email us at support@dolze.com.
Made with ❤️ by the Dolze Team
Project details
Release history Release notifications | RSS feed
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 dolze_image_templates-0.10.3.tar.gz.
File metadata
- Download URL: dolze_image_templates-0.10.3.tar.gz
- Upload date:
- Size: 8.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4882bc7de0f3076dd0b2b7dcddb636e74943dcd5630950b2dac2d97999f76901
|
|
| MD5 |
34f74980963d2c8c5f2280ede7cfc636
|
|
| BLAKE2b-256 |
758d31fbd3dbf2e9d5c91df70c0e8fcf9477643be194a4358657167b31b6eddc
|
File details
Details for the file dolze_image_templates-0.10.3-py3-none-any.whl.
File metadata
- Download URL: dolze_image_templates-0.10.3-py3-none-any.whl
- Upload date:
- Size: 8.9 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ce469cb922e87e2d8b92fca59a1497e46daa0063842c99f1ff1f6cbcffc5bb7a
|
|
| MD5 |
9610a701bf1372e5f90f137bb745209f
|
|
| BLAKE2b-256 |
023c5af903faf7a7810688a268762104b990e372661dbc90f9b2a4f52f427ecf
|